Customers
Create, update and fetch contracts information.
Received's Customers' APIs allow our users to manage their customers and subscribers. The APIs support operations such as creating a new customer, updating existing customers and fetching customers' related data.
Don't forget! APIs must include:
Bearer Token - return from the login call
API version - {"Version": "V0"}
Adding Customer For Debit Entity
Adding a new customer for the receiving entity involves registering their details and payment information, enhancing the entity's client base and opening avenues for increased revenue streams.
Add Customer
Responses
Request Schema
Term | Type | Description | Example |
---|---|---|---|
| String | Company name | Acme |
| String | Company's email addresses comma separated | admin1@acme.com, admin2@acme.com |
| String | Company's legal name - documents use | Acme Inc. |
| Number | Employer identification number | 12-3456789 |
| Number | Company's phone number in international format (7-20 digits) | 2121234567 |
| Number | Country code (1-4 digits) | 123 |
| String | Company's country of operation | United States |
| String | Company's state of operation | NY |
| String | Company's city of operation | New York |
| Number | Company's zip code | 10001 |
| String | Company's billing address | 643 Mundy St, Watertown, New York(NY), 13601 |
| String | Company's shipping address | 643 Mundy St, Watertown, New York(NY), 13601 |
| String | The default currency that is used for this company | USD |
| Number | Value Added Tax - in percentage | 17 |
| String | The ID of the related supplier entity | fae8fc36-d321-473f-9890-a9cb16deb4dd |
| Number | The default net terms used for this company, It must be a positive number or a payment term: "DUE_UPON_RECEIPT", "DUE_UPON_USAGE" | 30 |
| Object String | Bank account details The ID of the bank account | |
| Object Boolean String String | Online payment details Indicates whether the charging should be automatic or not The ID of the payment gateway The ID of a specific card defined in the payment gateway account, such as Stripe card id | |
| Object String Array | The details of the crypto wallet The address of the crypto wallet The crypto tokens that supported by the wallet | |
| String Boolean Boolean | Set usage reports for Invoice email: Attach logs csv to invoice email Attach logs appendix to invoice PDF |
Response Schema
Term | Type | Description | Exmaple |
---|---|---|---|
| String | Customer reference | dcaff9c0-4a9c-4d01-b2dc-0da7efcc616c |
Get Debit Entity
Responses
Explore More APIs
Delves into additional customers methods, broadening your integration capabilities and enhancing secure access
List All Customers
Filter List Of Customers
Customer Invoices
See invoices API
List All Debit Entities
Response
Response Schema
Term | Type | Description | Exmaple |
---|---|---|---|
entity_ref | String | The ID of the supplier entity | dcaff9c0-4a9c-4d01-b2dc-0da7efcc616c |
entity_name | String | The name of the supplier entity | Acme |
entity_legal_name | String | The legal name of the supplier entity - used of documents | Acme Ltd. |
Last updated