PUT /purchase-invoices/{id}.json
PUT
/purchase-invoices/{id}.json
Path parameters
-
id integer(int64) Required
Numeric ID of the instance
Minimum value is
1
.
Body Required
-
accountingError string | null
Accounting error
-
accountingIntegrationExternalId boolean | null
Accounting integration external
-
adjustment number | null
Adjustment
-
adjustmentReason string | null
Adjustment reason
-
commissionMethod string | null Required
Commission method
Values are
retained
orreverse
. Default value isretained
. -
createdAt string(date-time) | null
Created at
-
externalId string | null
External
-
finalized boolean | null Required
Finalized
Default value is
false
. -
id integer(int32)
Id
-
invoicingStage string | null Required
Invoicing stage
Values are
beforeShipping
,afterShipping
,delivered
, ormanual
. Default value ismanual
. -
paid number Required
Paid
Default value is
0
. -
paymentStatus string Required
Payment status
Values are
notPaid
,partiallyPaid
, orpaid
. Default value isnotPaid
. -
purchaseId integer(int32) Required
Purchase
-
quickbooksId string | null
Quickbooks
-
reference string Required
Reference
-
source string | null Required
Source
Values are
manual
,automated
, orcatchup
. Default value isautomated
. -
updatedAt string(date-time) | null
Updated at
-
xeroId string | null
Xero
PUT /purchase-invoices/{id}.json
curl \
-X PUT http://api.example.com/v1/purchase-invoices/{id}.json \
-H "Content-Type: application/json" \
-d '{"accountingError":"string","accountingIntegrationExternalId":true,"adjustment":42.0,"adjustmentReason":"string","commissionMethod":"retained","createdAt":"2023-05-04T09:42:00+00:00","externalId":"string","files":{},"finalized":false,"id":42,"invoicingStage":"manual","paid":0,"paymentStatus":"notPaid","purchaseId":42,"quickbooksId":"string","reference":"string","source":"automated","updatedAt":"2023-05-04T09:42:00+00:00","xeroId":"string"}'
Request example
{
"accountingError": "string",
"accountingIntegrationExternalId": true,
"adjustment": 42.0,
"adjustmentReason": "string",
"commissionMethod": "retained",
"createdAt": "2023-05-04T09:42:00+00:00",
"externalId": "string",
"files": {},
"finalized": false,
"id": 42,
"invoicingStage": "manual",
"paid": 0,
"paymentStatus": "notPaid",
"purchaseId": 42,
"quickbooksId": "string",
"reference": "string",
"source": "automated",
"updatedAt": "2023-05-04T09:42:00+00:00",
"xeroId": "string"
}