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

Fetch an invoice¶

GET /invoice/{invoiceLocator}

Request:

Name	Position	Type	Required
invoiceLocator	path	string	required

Response: PolicyInvoiceResponse

Pay an invoice¶

POST /invoice/{invoiceLocator}/pay

Request:

Name	Position	Type	Required
invoiceLocator	path	string	required
invoicePaymentRequest	body	InvoicePaymentRequest	optional

Response: PaymentResponse

InvoicePaymentRequest¶

optional
fieldValues map<string,[string]>
payment PaymentCreateRequest
paymentLocator string

Write-off an invoice¶

PATCH /invoice/{invoiceLocator}/writeOff

Request:

Name	Position	Type	Required
invoiceLocator	path	string	required

Response: PolicyInvoiceResponse

Fetch financial transactions for an invoice¶

GET /invoice/{invoiceLocator}/financialTransactions

Request:

Name	Position	Type	Required
invoiceLocator	path	string	required

Response: GetInvoiceFinancialTransactionsResponse

GetInvoiceFinancialTransactionsResponse¶

required
financialTransactions [FinancialTransactionResponse]