...
| URL | GET | POST | PUT | PATCH | DELETE | Status |
|---|---|---|---|---|---|---|
| /Customers | retrieve all customers | create a new customer |  | |||
| /Customers/:CustomerNumber | retrieve one customer | udpate existing customer  | | |||
| /Customers/:CustomerId/Contracts | get all contracts for a customer | | ||||
| /Contracts | get all contracts | create a new contract |
| |||
| /Contracts/:ContractId/Transactions | get all transactions for a given contract | create a new transaction for a contract | | |||
| /Contracts/:ContractId/Subscription | get the subscription for a contract | create a new subscription for a contract | | |||
| /Invoices | retrieve all invoices | | ||||
| /Projects | retrieve all projects | |
...
| Code Block |
|---|
{
"salutation": "MR",
"firstName": "John",
"lastName": "Doe",
"companyName": "MegaCorp",
"locale": "de_DE",
"websiteUri": "",
"phone1": "+49 89 224433",
"phone2": "",
"telefax": "",
"mobile": "",
"email": "info@megacorp.com",
"birthdate": "1980-11-02",
"euTaxId": "",
"taxNumber": "",
"noteText": null,
"postalAddress": null,
"billingAddress": {
"addressLine1": "Arlington Road 1",
"addressLine2": "",
"addressLine3": "",
"zipCode": "80333",
"cityName": "Example Town",
"state": "",
"country": "DE"
},
"paymentMethod": null,
"emailInvoice": "",
"taxRegion": "NATIONAL",
"duePeriod": "0",
"dueUnit": "DAY"
} |
POST /Contracts
Create a new contract for a customer. Adding a subscription is optional.
Example request with subscription:
| Code Block |
|---|
{
"accountNumber": 2,
"customerNumber": "CUST1001",
"projectName": "Projekt1",
"subscription": {
"termPeriod": 1,
"termUnit": "MONTH",
"noticePeriod": 4,
"noticeUnit": "WEEK",
"continuePeriod": 1,
"continueUnit": "MONTH",
"billedInAdvance": true,
"subscriptionItems": [{
"quantity": 1,
"extraDescription": "",
"itemNumber": "item001"
}
]
},
"issueDate": "2016-11-14",
"recur": 6,
"recurUnit": "MONTH",
"duePeriod": null,
"dueUnit": null,
"paymentMethod": null
} |