7x Developer Portal & API Documentation

Retrieves invoice data for a payment reference and order type in the PO Box domain. Can return invoice content or file-oriented payload depending on IsFile.

Request builder

GET

/api/v1/Invoice

Access Token

PaymentReferenceNumberstring

Typestring

IsFileboolean

api-versionstring

Reference details

Authorization

OAuth2

AuthorizationBearer <token>

In: header

Query Parameters

PaymentReferenceNumber?string

Type?string

Value in

"RENT"
"RENEWAL"
"UPGRADE"
"CANCELLATION"
"DUE_PAYMENT"
"ADD_CHANGE"
"DOWNGRADE"
"ADDITIONAL_AGENT"
"ADDITIONAL_TIJARI"
"PAY_FOR_SHIPMENT"
"CHANGE_LOCK"

IsFile?boolean

api-version?string

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/Invoice"

{}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "errors": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "property1": null,  "property2": null}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "property1": null,  "property2": null}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "property1": null,  "property2": null}

Overview

Retrieves invoice data for a payment reference and order type in the PO Box domain. Can return invoice content or file-oriented payload depending on IsFile.

Request builder

GET

/api/v1/Invoice

Access Token

PaymentReferenceNumberstring

Typestring

IsFileboolean

api-versionstring

Reference details

Authorization

OAuth2

AuthorizationBearer <token>

In: header

Query Parameters

PaymentReferenceNumber?string

Type?string

Value in

"RENT"
"RENEWAL"
"UPGRADE"
"CANCELLATION"
"DUE_PAYMENT"
"ADD_CHANGE"
"DOWNGRADE"
"ADDITIONAL_AGENT"
"ADDITIONAL_TIJARI"
"PAY_FOR_SHIPMENT"
"CHANGE_LOCK"

IsFile?boolean

api-version?string

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/Invoice"

{}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "errors": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "property1": null,  "property2": null}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "property1": null,  "property2": null}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "property1": null,  "property2": null}

Authorization

Query Parameters

Response Body

200application/json

400application/json

404application/json

500application/json

Authorization

Query Parameters

Response Body

200application/json

400application/json

404application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`