Invoice API
Endpoint Index
| Action | Endpoint |
|---|---|
| Fetch an invoice | GET /invoice/{invoiceLocator} |
| Pay an invoice | POST /invoice/{invoiceLocator}/pay |
| Write-off an invoice | PATCH /invoice/{invoiceLocator}/writeOff |
| Fetch financial transactions for an invoice | GET /invoice/{invoiceLocator}/financialTransactions |
Details
Fetch an invoice¶
GET /invoice/{invoiceLocator}Request:
| Name | Position | Type | Required |
|---|---|---|---|
| invoiceLocator | path | string | required |
Response:
PolicyInvoiceResponsePay an invoice¶
POST /invoice/{invoiceLocator}/payRequest:
| Name | Position | Type | Required |
|---|---|---|---|
| invoiceLocator | path | string | required |
| invoicePaymentRequest | body | InvoicePaymentRequest | optional |
Response:
PaymentResponseInvoicePaymentRequest¶
optionalfieldValues map<string,[string]>payment PaymentCreateRequestpaymentLocator string
Write-off an invoice¶
PATCH /invoice/{invoiceLocator}/writeOffRequest:
| Name | Position | Type | Required |
|---|---|---|---|
| invoiceLocator | path | string | required |
Response:
PolicyInvoiceResponseFetch financial transactions for an invoice¶
GET /invoice/{invoiceLocator}/financialTransactionsRequest:
| Name | Position | Type | Required |
|---|---|---|---|
| invoiceLocator | path | string | required |
Response:
GetInvoiceFinancialTransactionsResponseGetInvoiceFinancialTransactionsResponse¶
requiredfinancialTransactions [FinancialTransactionResponse]