Invoice API
Endpoint Index
| Action | Endpoint |
|---|---|
| Fetch an invoice | GET /invoice/{invoiceLocator} |
| Pay an invoice | POST /invoice/{invoiceLocator}/pay |
| 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 |
| paymentCreateRequest | body | PaymentCreateRequest | optional |
Response:
PaymentResponsePaymentCreateRequest¶
optionalfieldValues map<string,[string]>
Fetch financial transactions for an invoice¶
GET /invoice/{invoiceLocator}/financialTransactionsRequest:
| Name | Position | Type | Required |
|---|---|---|---|
| invoiceLocator | path | string | required |
Response:
GetInvoiceFinancialTransactionsResponseGetInvoiceFinancialTransactionsResponse¶
requiredfinancialTransactions [FinancialTransactionResponse]