Jetti API documentation

GET /purchase-invoices/{id}.json

Path parameters

id integer(int64) Required

Numeric ID of the instance

Minimum value is 1.

Responses

• 200

Successful response
Hide response attributes Show response attributes object
- 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 or reverse. Default value is retained.
- createdAt string(date-time) | null
  
  Created at
- externalId string | null
  
  External
- files object | null | array | boolean | integer | number | string
  
  Any of:
  object-1 object | null array-2 array | null boolean-3 boolean | null integer-4 integer | null number-5 number | null string-6 string | null
  
  Files
  
  Files
  
  Files
  
  Files
  
  Files
  
  Files
- finalized boolean | null Required
  
  Finalized
  
  Default value is false.
- id integer(int32)
  
  Id
- invoicingStage string | null Required
  
  Invoicing stage
  
  Values are beforeShipping, afterShipping, delivered, or manual. Default value is manual.
- paid number Required
  
  Paid
  
  Default value is 0.
- paymentStatus string Required
  
  Payment status
  
  Values are notPaid, partiallyPaid, or paid. Default value is notPaid.
- purchaseId integer(int32) Required
  
  Purchase
- quickbooksId string | null
  
  Quickbooks
- reference string Required
  
  Reference
- source string | null Required
  
  Source
  
  Values are manual, automated, or catchup. Default value is automated.
- updatedAt string(date-time) | null
  
  Updated at
- xeroId string | null
  
  Xero

GET /purchase-invoices/{id}.json

curl \
 -X GET http://api.example.com/v1/purchase-invoices/{id}.json

Response examples (200)

{
  "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"
}