Retrieve Sales Order

GET 
/accounting/sales-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

salesOrder

object

id string

remoteId string

salesOrderStatus

salesOrderNumber string

issueDate string

dueDate string

paidOnDate

deliveryDate

deilveryAddress

customerId string

accountId string

memo

companyId

totalTaxAmount

totalAmount integer

Default value: 0

currency string

exchangeRate integer

Default value: 0

totalDiscount

subTotal

lineItems

object[]

Array [

totalAmount integer

Default value: 0

accountingItemId string

remoteId string

]

trackingCategoryIds array

remoteCreatedAt string

remoteUpdatedAt string

remoteDeleted boolean

Default value: true

createdAt string

updatedAt string

Example (from schema)

{
  "salesOrder": {
    "id": "00000000-0000-0000-0000-000000000000",
    "remoteId": "361",
    "salesOrderStatus": {},
    "salesOrderNumber": "SO117",
    "issueDate": "2023-10-10",
    "dueDate": "2023-10-10",
    "paidOnDate": {},
    "deliveryDate": {},
    "deilveryAddress": {},
    "customerId": "00000000-0000-0000-0000-000000000000",
    "accountId": "00000000-0000-0000-0000-000000000000",
    "memo": {},
    "companyId": {},
    "totalTaxAmount": {},
    "totalAmount": 100,
    "currency": "USD",
    "exchangeRate": 1,
    "totalDiscount": {},
    "subTotal": {},
    "lineItems": [
      {
        "totalAmount": 100,
        "accountingItemId": "00000000-0000-0000-0000-000000000000",
        "remoteId": "1"
      }
    ],
    "trackingCategoryIds": [
      null
    ],
    "remoteCreatedAt": "2023-10-29T06:52:05.000Z",
    "remoteUpdatedAt": "2023-10-29T06:52:05.000Z",
    "remoteDeleted": false,
    "createdAt": "2024-02-22T11:17:23.939Z",
    "updatedAt": "2024-02-22T13:53:08.847Z"
  }
}

Result

{
	"salesOrder": {
		"id": "00000000-0000-0000-0000-000000000000",
		"remoteId": "361",
		"salesOrderStatus": null,
		"salesOrderNumber": "SO117",
		"issueDate": "2023-10-10",
		"dueDate": "2023-10-10",
		"paidOnDate": null,
		"deliveryDate": null,
		"deilveryAddress": null,
		"customerId": "00000000-0000-0000-0000-000000000000",
		"accountId": "00000000-0000-0000-0000-000000000000",
		"memo": null,
		"companyId": null,
		"totalTaxAmount": null,
		"totalAmount": 100,
		"currency": "USD",
		"exchangeRate": 1,
		"totalDiscount": null,
		"subTotal": null,
		"lineItems": [
			{
				"totalAmount": 100,
				"accountingItemId": "00000000-0000-0000-0000-000000000000",
				"remoteId": "1"
			},
			{
				"totalAmount": 100
			}
		],
		"trackingCategoryIds": [],
		"remoteCreatedAt": "2023-10-29T06:52:05.000Z",
		"remoteUpdatedAt": "2023-10-29T06:52:05.000Z",
		"remoteDeleted": false,
		"createdAt": "2024-02-22T11:17:23.939Z",
		"updatedAt": "2024-02-22T13:53:08.847Z"
	}
}

400

400

application/json

Schema

Schema

object

Example (from schema)

{}

Result

{}

Loading...