v1

latestOpenAPI 3.0.3Apache 2.02026-07-131453851.1 MB

Aged Creditors

Get Aged Creditors

get/accounting/aged-creditors

Query parameters

rawboolean

Include raw response. Mostly used for debugging purposes

customer_idstring

Filter by customer id

supplier_idstring

Filter by supplier id

report_as_of_datestring

The cutoff date for considering transactions

period_countinteger

Number of periods to split the aged creditors report into

period_lengthinteger

Length of each period in days

Apply filters

{
  "supplier_id": "123abc",
  "customer_id": "123abc",
  "report_as_of_date": "2024-01-01",
  "period_count": 3,
  "period_length": 30
}

example_downstream_propertystring

All passthrough query parameters are passed along to the connector as is (?pass_through[search]=leads becomes ?search=leads)

Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads

{
  "search": "San Francisco"
}

fieldsstring nullable

The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: fields=name,email,addresses.city<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.

Headers

x-apideck-consumer-idstring required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring required

The ID of your Unify application

x-apideck-service-idstring

Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.

x-apideck-company-idstring

The ID of the company to scope requests to. For connectors that support multi-company, this overrides the default company configured in connection settings.

Response

Aged Creditors

status_codeinteger required

HTTP Response Status Code

statusstring required

HTTP Response Status

servicestring required

Apideck ID of service provider

resourcestring required

Unified API resource name

operationstring required

Operation performed

_rawRaw nullable

Raw response from the integration when raw=true query param is provided