ReferencesOpenapiInvoice
List invoices
List invoices in the specified organisation and workspace, with optional search, status, type, and pagination filters.
Authorization
ApiKeyAuth x-api-key<token>
API key for authentication
In: header
Path Parameters
orgId*string
workspaceId*string
Query Parameters
search?string
status?string
type?string
page?number
Default
1Range
1 <= valuelimit?number
Default
10Range
1 <= value <= 50Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://app.np.aws.karia.com.au/api/v0/organisation/string/workspace/string/invoice"{
"items": [
{
"id": 0,
"referenceId": "string",
"name": "string",
"description": "string",
"status": "string",
"type": "string",
"frequency": "string",
"totalAmountDueExGst": "string",
"totalAmountDueGst": "string",
"totalAmountPaid": "string",
"dueDate": "string",
"createdAt": "string"
}
],
"pagination": {
"total": 0,
"page": 0,
"limit": 0,
"totalPages": 0
}
}{
"code": "BAD_REQUEST",
"message": "Invalid input data",
"issues": []
}{
"code": "UNAUTHORIZED",
"message": "Authorization not provided",
"issues": []
}{
"code": "FORBIDDEN",
"message": "Insufficient access",
"issues": []
}{
"code": "NOT_FOUND",
"message": "Not found",
"issues": []
}{
"code": "INTERNAL_SERVER_ERROR",
"message": "Internal server error",
"issues": []
}