Retrieve Payment

GET 
/accounting/payments/:id

Retrieve a Payment with the given id.

Request

Path Parameters

id stringrequired

The ID of the payment.

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

payment

object

id string

remoteId string

transactionDate string

customerId string

vendorId string

accountId string

currency string

exchangeRate integer

Default value: 0

companyId

totalAmount integer

Default value: 0

trackingCategoryIds array

remoteCreatedAt string

remoteUpdatedAt string

remoteDeleted boolean

Default value: true

createdAt string

updatedAt string

Example (from schema)

{
  "payment": {
    "id": "00000000-0000-0000-0000-000000000000",
    "remoteId": "325",
    "transactionDate": "2022-09-01T00:00:00.000Z",
    "customerId": "00000000-0000-0000-0000-000000000000",
    "vendorId": "00000000-0000-0000-0000-000000000000",
    "accountId": "00000000-0000-0000-0000-000000000000",
    "currency": "USD",
    "exchangeRate": 1,
    "companyId": {},
    "totalAmount": 50,
    "trackingCategoryIds": [
      null
    ],
    "remoteCreatedAt": "2022-09-02T06:23:03.000Z",
    "remoteUpdatedAt": "2023-10-11T04:48:19.000Z",
    "remoteDeleted": false,
    "createdAt": "2024-02-22T11:18:47.232Z",
    "updatedAt": "2024-02-22T13:55:37.343Z"
  }
}

Result

{
	"payment": {
		"id": "00000000-0000-0000-0000-000000000000",
		"remoteId": "325",
		"transactionDate": "2022-09-01T00:00:00.000Z",
		"customerId": "00000000-0000-0000-0000-000000000000",
		"vendorId": "00000000-0000-0000-0000-000000000000",
		"accountId": "00000000-0000-0000-0000-000000000000",
		"currency": "USD",
		"exchangeRate": 1,
		"companyId": null,
		"totalAmount": 50,
		"trackingCategoryIds": [],
		"remoteCreatedAt": "2022-09-02T06:23:03.000Z",
		"remoteUpdatedAt": "2023-10-11T04:48:19.000Z",
		"remoteDeleted": false,
		"createdAt": "2024-02-22T11:18:47.232Z",
		"updatedAt": "2024-02-22T13:55:37.343Z"
	}
}

400

400

application/json

Schema

Schema

object

Example (from schema)

{}

Result

{}

Loading...