Retrieve Purchase Order

GET 
/accounting/purchase-orders/:id

Retrieve a Purchase Order with the given id.

Request

Path Parameters

id stringrequired

The ID of the purchase order.

Query Parameters

credentialId stringrequired

The ID of the credential.

Header Parameters

Authorization stringrequired

Default value: bearer YOUR_API_KEY

Responses

200

200

application/json

Schema

Schema

purchaseOrder

object

id string

remoteId string

purchaseOrderStatus string

issueDate string

purchaseOrderNumber string

deliveryDate

deliveryAddress

object

addressType string

street1 string

street2 string

vendorId string

accountId string

memo

companyId

totalAmount integer

Default value: 0

currency string

exchangeRate integer

Default value: 0

lineItems

object[]

Array [

remoteId string

lineType string

trackingCategoryIds array

description string

accountingItemId string

totalLineAmount integer

Default value: 0

]

trackingCategoryIds array

remoteCreatedAt string

remoteUpdatedAt string

remoteDeleted boolean

Default value: true

createdAt string

updatedAt string

Example (from schema)

{
  "purchaseOrder": {
    "id": "00000000-0000-0000-0000-000000000000",
    "remoteId": "373",
    "purchaseOrderStatus": "Open",
    "issueDate": "2023-11-03T00:00:00.000Z",
    "purchaseOrderNumber": "1036",
    "deliveryDate": {},
    "deliveryAddress": {
      "addressType": "SHIPPING",
      "street1": "Sandbox-Test-7",
      "street2": "St1 Calle Hortencia # 9"
    },
    "vendorId": "00000000-0000-0000-0000-000000000000",
    "accountId": "00000000-0000-0000-0000-000000000000",
    "memo": {},
    "companyId": {},
    "totalAmount": 100,
    "currency": "USD",
    "exchangeRate": 1,
    "lineItems": [
      {
        "remoteId": "1",
        "lineType": "ItemBasedExpenseLineDetail",
        "trackingCategoryIds": [
          null
        ],
        "description": "Line Item 1",
        "accountingItemId": "00000000-0000-0000-0000-000000000000",
        "totalLineAmount": 100
      }
    ],
    "trackingCategoryIds": [
      null
    ],
    "remoteCreatedAt": "2023-11-03T08:50:33.000Z",
    "remoteUpdatedAt": "2023-11-03T08:50:33.000Z",
    "remoteDeleted": false,
    "createdAt": "2024-02-22T11:20:01.857Z",
    "updatedAt": "2024-02-22T13:57:52.896Z"
  }
}

Result

{
	"purchaseOrder": {
	  "id": "00000000-0000-0000-0000-000000000000",
	  "remoteId": "373",
	  "purchaseOrderStatus": "Open",
	  "issueDate": "2023-11-03T00:00:00.000Z",
	  "purchaseOrderNumber": "1036",
	  "deliveryDate": null,
	  "deliveryAddress": {
	      "addressType": "SHIPPING",
	      "street1": "Sandbox-Test-7",
	      "street2": "St1 Calle Hortencia # 9"
	  },
	  "vendorId": "00000000-0000-0000-0000-000000000000",
	  "accountId": "00000000-0000-0000-0000-000000000000",
	  "memo": null,
	  "companyId": null,
	  "totalAmount": 100,
	  "currency": "USD",
	  "exchangeRate": 1,
	  "lineItems": [
	      {
	          "remoteId": "1",
	          "lineType": "ItemBasedExpenseLineDetail",
	          "trackingCategoryIds": [],
	          "description": "Line Item 1",
	          "accountingItemId": "00000000-0000-0000-0000-000000000000",
	          "totalLineAmount": 100
	      }
	  ],
	  "trackingCategoryIds": [],
	  "remoteCreatedAt": "2023-11-03T08:50:33.000Z",
	  "remoteUpdatedAt": "2023-11-03T08:50:33.000Z",
	  "remoteDeleted": false,
	  "createdAt": "2024-02-22T11:20:01.857Z",
	  "updatedAt": "2024-02-22T13:57:52.896Z"
	}
}

400

400

application/json

Schema

Schema

object

Example (from schema)

{}

Result

{}

Loading...