Invoice API

Fetch an invoice

GET /invoice/{invoiceLocator}

• Request:

  Name	Position	Type	Required
  invoiceLocator	path	string	required

• Response:PolicyInvoice2Response

Pay an invoice

POST /invoice/{invoiceLocator}/pay

• Request:

  Name	Position	Type	Required
  invoiceLocator	path	string	required
  paymentCreateRequest	body	PaymentCreateRequest	optional

• Response:PaymentResponse2

PaymentCreateRequest

{
  // Optional
  "fieldValues" : map<string,[string]>
}

PaymentResponse2

{
  // Required
  "amount" : number
  "amountCurrency" : string
  "displayId" : string
  "fieldValues" : map<string,[string]>
  "invoiceLocator" : string
  "locator" : string
  "mediaByLocator" : map<string,Media>
  "postedTimestamp" : integer
}

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]
}