Skip to main content
GET
/
api
/
engagements
/
card
/
{engagement-id}
/
invoices
/
{invoice-id}
Get invoice
curl --request GET \
  --url https://partner-card.test.public.rockerapi.dev/api/engagements/card/{engagement-id}/invoices/{invoice-id} \
  --header 'Authorization: Basic <encoded-value>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "invoiceNumber": "<string>",
  "engagementId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "dueDate": "2023-11-07T05:31:56Z",
  "billingPeriodStart": "<string>",
  "billingPeriodEnd": "<string>",
  "paymentReference": "<string>",
  "payeeAccountIdentifier": "<string>",
  "totalAmount": {
    "amount": 123,
    "currency": "<string>",
    "unit": "<string>"
  },
  "minimumAmount": {
    "amount": 123,
    "currency": "<string>",
    "unit": "<string>"
  },
  "invoicePdfDocumentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdDate": "2023-11-07T05:31:56Z",
  "payeeBankIdentifier": "<string>"
}

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

engagement-id
string<uuid>
required
invoice-id
string<uuid>
required

Response

id
string<uuid>
required
invoiceNumber
string
required
engagementId
string<uuid>
required
dueDate
string<date-time>
required
billingPeriodStart
string
required

ISO 8601 (YYYY-MM-DD)

billingPeriodEnd
string
required

ISO 8601 (YYYY-MM-DD)

paymentReference
string
required
payeeAccountIdentifier
string
required
totalAmount
object
required

Money object represented in the smallest currency unit

minimumAmount
object
required

Money object represented in the smallest currency unit

invoicePdfDocumentId
string<uuid>
required
createdDate
string<date-time>
required
payeeBankIdentifier
string