Sign in

v1

latestOpenAPI 3.0.3Apache 2.02026-08-062991191002.1 KB
Bill

Replaces the Bill resource.

Replaces the Bill resource.

put/bills/{id}

Path parameters

idstring required

Resource identifier

Request body

idstring

Unique identifier for this bill note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "quickbooks-345"

integrationstring

The key of the integration source e.g. "quickbooks", or "xero"

vendorIdstring

Vendor Id e.g. "15"

vendorNamestring nullable

Vendor full name e.g. "Acme Corp"

currencystring nullable

Currency code e.g. "USD"

balanceinteger

Total balance of the bill in cents e.g. 70000

txnDatestring date-time nullable

Transaction date e.g. "2021-05-12"

totalAmountinteger

Total amount of the bill in cents e.g. 550000

apAccountIdstring nullable

Account Id e.g. "15"

apAccountNamestring nullable

Account full name e.g. "Accounts Payable"

modifiedstring date-time

Date entry was last modified e.g. "2013-11-18T02:17:40.080Z"

createdstring date-time nullable

Date entry was created e.g. "2013-11-18T02:17:40.080Z"

srcIdstring

The unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S"

statusstring nullable

Bill status e.g. "Paid"

identifierstring nullable

The bill number e.g. "4560"

referenceNumberstring nullable

Reference number e.g. "1234"

dueDatestring date-time nullable

Date bill is due e.g. "2021-05-30"

subtotalinteger nullable

Bill subtotal in cents e.g. 65000

taxAmountinteger nullable

Bill tax amount in cents e.g. 12000

Example request

{
  "id": "quickbooks-345",
  "integration": "quickbooks",
  "vendorId": "15",
  "vendorName": "Acme Corp",
  "currency": "USD",
  "balance": 70000,
  "txnDate": "2021-05-12",
  "totalAmount": 550000,
  "apAccountId": "15",
  "apAccountName": "Accounts Payable",
  "modified": "2013-12-18T02:17:40.080Z",
  "created": "2013-11-18T02:17:40.080Z",
  "srcId": "GH2JK-67283H-YW82KHX-2883KK-KS78S",
  "status": "Paid",
  "identifier": "4560",
  "referenceNumber": "1234",
  "dueDate": "2021-05-30",
  "subtotal": 65000,
  "taxAmount": 12000
}

Response

Bill resource updated

idstring

Unique identifier for this bill note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "quickbooks-345"

integrationstring

The key of the integration source e.g. "quickbooks", or "xero"

vendorIdstring

Vendor Id e.g. "15"

vendorNamestring nullable

Vendor full name e.g. "Acme Corp"

currencystring nullable

Currency code e.g. "USD"

balanceinteger

Total balance of the bill in cents e.g. 70000

txnDatestring date-time nullable

Transaction date e.g. "2021-05-12"

totalAmountinteger

Total amount of the bill in cents e.g. 550000

apAccountIdstring nullable

Account Id e.g. "15"

apAccountNamestring nullable

Account full name e.g. "Accounts Payable"

modifiedstring date-time

Date entry was last modified e.g. "2013-11-18T02:17:40.080Z"

createdstring date-time nullable

Date entry was created e.g. "2013-11-18T02:17:40.080Z"

srcIdstring

The unique identifier of the source 3rd party integration e.g. "GH2JK-67283H-YW82KHX-2883KK-KS78S"

statusstring nullable

Bill status e.g. "Paid"

identifierstring nullable

The bill number e.g. "4560"

referenceNumberstring nullable

Reference number e.g. "1234"

dueDatestring date-time nullable

Date bill is due e.g. "2021-05-30"

subtotalinteger nullable

Bill subtotal in cents e.g. 65000

taxAmountinteger nullable

Bill tax amount in cents e.g. 12000

Example response

{
  "id": "quickbooks-345",
  "integration": "quickbooks",
  "vendorId": "15",
  "vendorName": "Acme Corp",
  "currency": "USD",
  "balance": 70000,
  "txnDate": "2021-05-12",
  "totalAmount": 550000,
  "apAccountId": "15",
  "apAccountName": "Accounts Payable",
  "modified": "2013-12-18T02:17:40.080Z",
  "created": "2013-11-18T02:17:40.080Z",
  "srcId": "GH2JK-67283H-YW82KHX-2883KK-KS78S",
  "status": "Paid",
  "identifier": "4560",
  "referenceNumber": "1234",
  "dueDate": "2021-05-30",
  "subtotal": 65000,
  "taxAmount": 12000
}