All API resources
Invoices
Finalised invoices: create, read and list them.
Base URL https://app.prosaic.works/api/public/v1. Every request needs an API key or access token; see the overview.
List invoices
/api/public/v1/invoicesSDK: prosaic.invoices.list(params)
Returns invoices in the active workspace that the authenticated user can access. Results are paginated and can be narrowed by client or entity. When both filters are supplied, an invoice must match both.
Query parameters
entityIdstringReturn invoices for one entity.
clientIdstringReturn invoices whose entity is associated with this client user.
statusstringFilter by persisted invoice lifecycle status.
One of:
DRAFT,FINALISED,PAID,VOIDEDupdatedSincestringReturn invoices updated on or after this ISO 8601 timestamp.
pageintegerDefault:
1pageSizeintegerDefault:
20
Responses
200 Successful response
dataarray of objectsrequiredShow 23 child attributesHide child attributes
idstringrequiredentityIdstringrequiredworkspaceIdstringrequiredfileIdstringrequirednullableinvoiceNumberstringrequirednullablestatusstringrequiredtaxModestringrequiredissueDatestring (date-time)requireddueDatestring (date-time)requirednullablesentAtstring (date-time)requirednullablerecipientNamestringrequiredrecipientEmailstringrequirednullablerecipientAddressstringrequirednullablebankAccountIdstringrequirednullablebankAccountNamestringrequirednullablesubtotalnumberrequiredtaxTotalnumberrequiredtotalnumberrequiredamountDuenumberrequirednullablenotesstringrequirednullablecreatedAtstring (date-time)requiredupdatedAtstring (date-time)requiredlinesarray of objectsrequiredShow 10 child attributesHide child attributes
idstringrequireddescriptionstringrequiredquantitynumberrequiredunitPricenumberrequiredtaxRatenumberrequiredtaxRateCodestringrequirednullableentityAccountIdstringrequirednullableamountnumberrequiredtaxAmountnumberrequiredpositionnumberrequired
paginationobjectrequiredShow 6 child attributesHide child attributes
currentPagenumberrequiredpageSizenumberrequiredtotalCountnumberrequiredtotalPagesnumberrequiredhasNextPagebooleanrequiredhasPreviousPagebooleanrequired
400Invalid query parameters.401Unauthorized.403Insufficient role.404Workspace not found.500Internal server error.
const page = await prosaic.invoices.list();curl https://app.prosaic.works/api/public/v1/invoices \
-H "Authorization: Bearer $PROSAIC_API_KEY"Get an invoice by ID for an entity
/api/public/v1/entities/{entityId}/invoices/{invoiceId}SDK: prosaic.invoices.retrieve(entityId, invoiceId)
Path parameters
entityIdstringrequiredinvoiceIdstringrequired
Responses
200 Successful response
dataobjectrequiredShow 23 child attributesHide child attributes
idstringrequiredentityIdstringrequiredworkspaceIdstringrequiredfileIdstringrequirednullableinvoiceNumberstringrequirednullablestatusstringrequiredtaxModestringrequiredissueDatestring (date-time)requireddueDatestring (date-time)requirednullablesentAtstring (date-time)requirednullablerecipientNamestringrequiredrecipientEmailstringrequirednullablerecipientAddressstringrequirednullablebankAccountIdstringrequirednullablebankAccountNamestringrequirednullablesubtotalnumberrequiredtaxTotalnumberrequiredtotalnumberrequiredamountDuenumberrequirednullablenotesstringrequirednullablecreatedAtstring (date-time)requiredupdatedAtstring (date-time)requiredlinesarray of objectsrequiredShow 10 child attributesHide child attributes
idstringrequireddescriptionstringrequiredquantitynumberrequiredunitPricenumberrequiredtaxRatenumberrequiredtaxRateCodestringrequirednullableentityAccountIdstringrequirednullableamountnumberrequiredtaxAmountnumberrequiredpositionnumberrequired
400Invalid invoice ID.401Unauthorized.404Invoice, entity, or workspace not found.500Internal server error.
const { data } = await prosaic.invoices.retrieve(entityId, invoiceId);curl https://app.prosaic.works/api/public/v1/entities/$ENTITY_ID/invoices/$INVOICE_ID \
-H "Authorization: Bearer $PROSAIC_API_KEY"Create a finalised invoice
/api/public/v1/entities/{entityId}/invoicesSDK: prosaic.invoices.create(entityId, params)
Creates a complete, finalised invoice for the specified entity. The
entity is taken from the URL; status cannot be supplied. Finalised
invoices are not automatically delivered to the recipient.
Where the workspace records invoices as receivables (accrual
accounting), finalising posts the invoice to the ledger, which needs a
contactId. Without one the request is refused with 409
INVOICE_NOT_EDITABLE and nothing is created.
Path parameters
entityIdstringrequired
Request body
application/json
taxModestringrequiredOne of:
NO_TAX,TAX_INCLUSIVE,TAX_EXCLUSIVEissueDatestringrequiredrecipientNamestringrequiredlinesarray of objectsrequiredShow 6 child attributesHide child attributes
descriptionstringrequiredquantitystringrequiredunitPricestringrequiredtaxRateCodestringrequiredentityAccountIdstringrequiredtaxRatestring
bankAccountIdstringnullablenotesstringnullablecontactIdstringnullabledueDatestringnullablebankAccountNamestringnullableinvoiceNumberstringrecipientEmailstringnullablerecipientAddressstringnullablerecipientEmailsarray of strings
Responses
201 Successful response
dataobjectrequiredShow 23 child attributesHide child attributes
idstringrequiredentityIdstringrequiredworkspaceIdstringrequiredfileIdstringrequirednullableinvoiceNumberstringrequirednullablestatusstringrequiredtaxModestringrequiredissueDatestring (date-time)requireddueDatestring (date-time)requirednullablesentAtstring (date-time)requirednullablerecipientNamestringrequiredrecipientEmailstringrequirednullablerecipientAddressstringrequirednullablebankAccountIdstringrequirednullablebankAccountNamestringrequirednullablesubtotalnumberrequiredtaxTotalnumberrequiredtotalnumberrequiredamountDuenumberrequirednullablenotesstringrequirednullablecreatedAtstring (date-time)requiredupdatedAtstring (date-time)requiredlinesarray of objectsrequiredShow 10 child attributesHide child attributes
idstringrequireddescriptionstringrequiredquantitynumberrequiredunitPricenumberrequiredtaxRatenumberrequiredtaxRateCodestringrequirednullableentityAccountIdstringrequirednullableamountnumberrequiredtaxAmountnumberrequiredpositionnumberrequired
400Invalid request or invoice input, or system account setup is missing or invalid (SYSTEM_ACCOUNT_VALIDATION).401Unauthorized.404Entity or workspace not found.409The invoice can't be finalised, for example it has no contact where the workspace uses accrual accounting.500Invoice creation failed.
const { data } = await prosaic.invoices.create(entityId, {
taxMode: 'NO_TAX',
issueDate: '2026-04-01',
recipientName: 'Example Ltd',
lines: [
{
description: 'Office supplies',
quantity: '1',
unitPrice: '100.00',
taxRateCode: 'TAX_RATE_CODE',
entityAccountId: 'ENTITY_ACCOUNT_ID',
},
],
});curl -X POST https://app.prosaic.works/api/public/v1/entities/$ENTITY_ID/invoices \
-H "Authorization: Bearer $PROSAIC_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"taxMode": "NO_TAX",
"issueDate": "2026-04-01",
"recipientName": "Example Ltd",
"lines": [
{
"description": "Office supplies",
"quantity": "1",
"unitPrice": "100.00",
"taxRateCode": "TAX_RATE_CODE",
"entityAccountId": "ENTITY_ACCOUNT_ID"
}
]
}'