Get an invoice's AP portal submission

GET

https://integrators.prod.api.tabsplatform.com/v16/customers/:customerId/invoices/:invoiceId/ap-portal-submission

GET

/v16/customers/:customerId/invoices/:invoiceId/ap-portal-submission

$ curl https://integrators.prod.api.tabsplatform.com/v16/customers/123e4567-e89b-12d3-a456-426614174000/invoices/123e4567-e89b-12d3-a456-426614174000/ap-portal-submission \
>      -H "Authorization: <apiKey>"

1 {
2   "payload": {
3     "id": "123e4567-e89b-12d3-a456-426614174000",
4     "invoiceId": "123e4567-e89b-12d3-a456-426614174000",
5     "accountId": "123e4567-e89b-12d3-a456-426614174000",
6     "portal": "COUPA",
7     "portalName": "Acme AP Hub",
8     "status": "SUBMITTED",
9     "statusDetail": "Rejected: PO number missing",
10     "portalExternalId": "REQ-88213",
11     "amount": "1250.00",
12     "currency": "USD",
13     "submittedAt": "2023-01-01T00:00:00.000Z",
14     "estimatedPaymentAt": "2023-02-01T00:00:00.000Z",
15     "paidAt": "2023-02-03T00:00:00.000Z",
16     "lastSyncedAt": "2023-01-01T00:00:00.000Z",
17     "createdAt": "2023-01-01T00:00:00.000Z",
18     "updatedAt": "2023-01-01T00:00:00.000Z"
19   },
20   "success": true,
21   "message": "string",
22   "error": {
23     "code": 1.1,
24     "message": "string",
25     "details": {}
26   }
27 }

Returns the invoice's AP portal submission, or 404 if the invoice has none.

Authentication

Authorizationstring

API Key authentication via header

Path parameters

customerIdstringRequired

Customer ID

invoiceIdstringRequired

Invoice ID

Response

The AP portal submission

payloadobject

Response payload, will be empty when success is false

successboolean

Boolean with true=success, false=failure

messagestring

Plain-text description of the result

errorobjectOptional

json element with any error messages or warnings

Errors

400

Bad Request Error

404

Not Found Error

500

Internal Server Error