Closing Documents Information

Closing Documents Information

https://api.worldota.net/api/b2b/v3/general/document/closing_documents/info/

The call gets the confirmatory accounting documents details.

Use the call to:

  • Check the details on confirmatory accounting documents.
  • And get a package_id field value for the Closing Documents Download call.

Request example

curl --user <KEY_ID>:<API_KEY> 'https://api.worldota.net/api/b2b/v3/general/document/closing_documents/info/?data={%22order_ids%22%3A55225%2C%22seal%22%3Atrue}'

Parameters

ℹ️

The following fields are required:

  • The agreement_numbers and issue_date.
  • Or the order_ids.
agreement_numbers String, Query optional
The contract agreement numbers.
issue_date String, Query optional
The confirmatory accounting documents’ issue date.
order_ids String, Query optional
The order ID.

Response

packages Object optional

The confirmatory accounting document list.

agreement_number String required
The contract agreement number.
order_ids [Int] required
The order ID.
package_id Int required
The confirmatory accounting document ID.
package_issue_date String required
The confirmatory accounting document issue date.
package_number String required
The confirmatory accounting document number.
reporting_month Int required
The confirmatory accounting document reporting month.
reporting_year Int required
The confirmatory accounting document reporting year.
total_commission Number required
The agent remuneration during the reporting month.
total_sum Number required
The bookings total amount during the reporting month.
total_vat Number required
The bookings total VAT during the reporting month.

Errors

The error field has the value specified in the headers below.

invalid_params

The call is requested with the incorrect order of parameters. The correct order is:

  • The agreement_numbers and issue_date.
  • Or the order_ids.

invalid_params_issue_date_agreement_numbers

The agreement_numbers and issue_date fields should be requested together.

orders_not_found

The order with the order_id field value isn’t found.

agreements_not_found

The documents with the agreement_numbers field value aren’t found.