Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

For your own scripts and server-to-server integrations. Create a key in the app under Settings > Access > API keys and copy it then, because it is shown once. Send it as Authorization: Bearer <key>. The key acts as the member who made it, in the organization it was made in. A call needs the member's permission and one of the key's scopes, such as inventory:read or sales:write. A key with * has every scope.

Path Parameters

invoice
string
required

Body

application/json

A payment made elsewhere.

amount
string
required

Above zero, to the cent, and no more than is outstanding.

Pattern: ^(?!0+(\.0+)?$)\d{1,18}(\.\d{1,2})?$
paid_on
string<date> | null

Today when left out.

method
string | null

How it was paid, such as Bank transfer.

Maximum string length: 64
reference
string | null
Maximum string length: 128

Response

SalesInvoiceResource

data
SalesInvoiceResource · object
required