Contracts
Create, update and fetch contracts information.
Received's Contract APIs allow users to manage their contracts. The APIs support operations such as creating a new contract, manipulating existing contracts, cancelling active contracts and fetching contracts' related data.
Don't forget! APIs must include:
Bearer Token - return from the login call
API version - {"Version": "V0"}
Mange customer contracts
Customers & Products
Please refer to Customer and Product APIs pages
Create Contract
Response
Request Schema
Contract scheme
Field Name | Type | Description | Example |
---|---|---|---|
| String | The ID of the related customer | 3a7b0f7d-fdf6-4f54-90f4-2307b73ae85f |
| String | Purchase order number | PO-2024-12345 |
| Array<Product> | A list of the products associated with the contract |
Product schema
Field Name | Type | Description | Example |
---|---|---|---|
| String | The ID of the related pricing model | 3a7b0f7d-fdf6-4f54-90f4-2307b73ae85f |
| String | Billing start date | 2024-01-01 |
| String | Billing end date | 2025-12-31 |
| Array | Selected lineitems from the pricing. If not set, all lineitems in the pricing will be added. Empty list will add pricing with no lineitems. | |
| String | The ID of the related lineitem in the pricing model | 3a7b0f7d-fdf6-4f54-90f4-2307b73ae85f |
| String | The ID of the related supplier entity | 7f90df6e-b833-4bfa-b6d8-ac6cbe347bc6 |
| Object | The interval of time during which invoices are prepared | |
| String | The time unit of the interval. Options | MONTHLY |
| Number | The number of time units between the intervals | 1 |
| String | The date when the first invoice should be issued. Standard date format "ISO 8601". If not defined, will be set s.t. last invoice will not be partial. | 2024-02-10 |
| String | Determines the timing of the payment relative to the billing period. Options | BEFORE_PERIOD |
| Number | The percentage of tax to apply on the invoices | 17 |
| Number | The percentage of discount to apply on the invoices | 10 |
| String | An free-form text field related to the contract | "Special offer" |
| Object | Bank account details | |
| String | The ID of the bank account | 3a7b0f7d-fdf6-4f54-90f4-2307b73ae85f |
| Object | Online payment details | |
| Boolean | Indicates whether the charging should be automatic or not | true |
| String | The ID of the payment gateway | 3a7b0f7d-fdf6-4f54-90f4-2307b73ae85f |
| String | The ID of a specific card defined in the payment gateway account | card_abcdef1234567890 |
| Object | The details of the crypto wallet | |
| String | The address of the crypto wallet | 1Lbcfr7sAHTD9CgdQo3HTMTkV8LK4ZnX71 |
| Array | The crypto tokens that supported by the wallet | ["BTC", "ETH"] |
| Number | The default net terms used for this company, It must be a positive number or a payment term "DUE_UPON_RECEIPT" | DUE_UPON_RECEIPT |
Response Schema
Term | Type | Description | Example |
---|---|---|---|
| String | Contract reference | 32c320bb-431b-488f-bcd4-729e495a33ad |
Cancel Contract
Response
Request Schema
Term | Type | Description | Example |
---|---|---|---|
| String | Contract reference | 32c320bb-431b-488f-bcd4-729e495a33ad |
Edit Contract
Response
Request Schema
In addition to the contract schema (see Create Contract above):
Field Name | Description | Example | |
---|---|---|---|
| String | The ID of the edited contract | 3a7b0f7d-fdf6-4f54-90f4-2307b73ae85f |
| Boolean | Should the change be applied on the current invoice or start from the next one. The default value is "false" | false |
Explore More APIs
Delves into additional contracts methods, broadening your integration capabilities and enhancing secure access
Get Contract
Response
Get Customer Contracts
URL Params
Field Name | Description | Example | |
---|---|---|---|
| String | The ID of the customer | |
| Number | Page size | 20 |
| Number | Page number | 0 |
Response
Contract invoices
See invoices API
Get Current Invoices
Returns the invoices for the ongoing billing period of the contract.
Response
Invoices schema can be found in invoices page
Get Next Invoices
Returns the invoices for the next billing period of the contract.
Response
Invoices schema can be found in invoices page
Last updated