Skip to main content
GET
/
api
/
Clients
/
{clientId}
/
Invoices
Get Invoices.
curl --request GET \
  --url https://api.example.com/api/Clients/{clientId}/Invoices
[
  {
    "id": 123,
    "typeID": 1,
    "typeName": "<string>",
    "statusID": 0,
    "statusName": "<string>",
    "clientID": 123,
    "clientName": "<string>",
    "billingContactID": 123,
    "billingContactName": "<string>",
    "entityID": 123,
    "playerID": 123,
    "createdDate": "2023-11-07T05:31:56Z",
    "createdByID": 123,
    "createdByName": "<string>",
    "updatedDate": "2023-11-07T05:31:56Z",
    "updatedByID": 123,
    "updatedByName": "<string>",
    "deletedDate": "2023-11-07T05:31:56Z",
    "deletedByID": 123,
    "deletedByName": "<string>",
    "approved": true,
    "approvedDate": "2023-11-07T05:31:56Z",
    "approvedByID": 123,
    "approvedByName": "<string>",
    "creditedDate": "2023-11-07T05:31:56Z",
    "creditedByID": 123,
    "creditedByName": "<string>",
    "creditInvoiceID": 123,
    "date": "2023-11-07T05:31:56Z",
    "dueDate": "2023-11-07T05:31:56Z",
    "clientReference": "<string>",
    "externalReference": "<string>",
    "externalInvoiceNumber": "<string>",
    "externalInvoiceDate": "2023-11-07T05:31:56Z",
    "subTotal": 123
  }
]

Path Parameters

clientId
integer<int32>
required

Response

200 - application/json

OK

id
integer<int32>
typeID
enum<integer>
Available options:
1,
2
typeName
string | null
statusID
enum<integer>
Available options:
0,
1,
2,
3,
4
statusName
string | null
clientID
integer<int32>
clientName
string | null
billingContactID
integer<int32>
billingContactName
string | null
entityID
integer<int32>
playerID
integer<int32>
createdDate
string<date-time> | null
createdByID
integer<int32> | null
createdByName
string | null
updatedDate
string<date-time> | null
updatedByID
integer<int32> | null
updatedByName
string | null
deletedDate
string<date-time> | null
deletedByID
integer<int32> | null
deletedByName
string | null
approved
boolean
approvedDate
string<date-time> | null
approvedByID
integer<int32> | null
approvedByName
string | null
creditedDate
string<date-time> | null
creditedByID
integer<int32> | null
creditedByName
string | null
creditInvoiceID
integer<int32> | null
date
string<date-time>
dueDate
string<date-time>
clientReference
string | null
externalReference
string | null
externalInvoiceNumber
string | null
externalInvoiceDate
string<date-time> | null
subTotal
number<double>