Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
POST | /billing/company/ | Add new billing information. | Add new billing information. |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CompanyId | body | Guid? | No | The company id, if empty will use the company id for the user you are logged in with. |
BillingMethodId | body | int | Yes | The prefered billing method. |
Name | body | string | No | The name that should be printed on the billing information, normally this would be your company name. |
Attention | body | string | No | If you want to add the attention to the billing address. |
Street1 | body | string | No | The street for the billing adress. This is required when having postal invoice as billing method. |
Street2 | body | string | No | The street for the billing adress. |
ZipCode | body | string | No | The zip code (postal code) for the billing adress. This is required when having postal invoice as billing method. |
City | body | string | No | The city for the billing adress. This is required when having postal invoice as billing method. |
CountryId | body | string | No | The country for the billing adress. This is required when having postal invoice as billing method. |
body | string | No | The billing email. This is required when having email invoice as billing method. | |
PaymentTermsDays | body | int? | No | The billing payment terms in days. This is default 15 days. |
VatRegistrationNumber | body | string | No | The company vat registration number. |
GLN | body | string | No | The company global location number. |
ReferenceLine1 | body | string | No | You're internal rereference. |
ReferenceLine2 | body | string | No | You're internal rereference. |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CompanyId | form | Guid | No | The company id. |
BillingMethodId | form | int | Yes | The prefered billing method. |
Name | form | string | No | The name that should be printed on the billing information, normally this would be your company name. |
Attention | form | string | No | If you want to add the attention to the billing address. |
Street1 | form | string | No | The street for the billing adress. This is required when having postal invoice as billing method. |
Street2 | form | string | No | The street for the billing adress. |
ZipCode | form | string | No | The zip code (postal code) for the billing adress. This is required when having postal invoice as billing method. |
City | form | string | No | The city for the billing adress. This is required when having postal invoice as billing method. |
CountryId | form | string | No | The country for the billing adress. This is required when having postal invoice as billing method. |
form | string | No | The billing email. This is required when having email invoice as billing method. | |
GLN | form | string | No | The company global location number. |
ReferenceLine1 | form | string | No | You're internal rereference. |
ReferenceLine2 | form | string | No | You're internal rereference. |
PaymentTermsDays | form | int | No | The billing payment terms in days. This is default 15 days. |
VatRegistrationNumber | form | string | No | The company vat registration number. |
BillingMethodOptions | form | List<BillingMethod> | No | The billing method options to choose from |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
BillingMethodCountriesRelation | form | List<BillingMethodCountriesRelation> | No | |
Name | form | string | Yes | |
Description | form | string | Yes | |
ModifiedDate | form | DateTimeOffset? | No | |
Id | form | int | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
BillingMethodId | form | int | Yes | |
CountryId | form | string | Yes | |
ModifiedDate | form | DateTimeOffset? | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /billing/company/ HTTP/1.1
Host: api.bokamera.se
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<AddBillingInformation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
<Attention>String</Attention>
<BillingMethodId>0</BillingMethodId>
<City>String</City>
<CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
<CountryId>String</CountryId>
<Email>String</Email>
<GLN>String</GLN>
<Name>String</Name>
<PaymentTermsDays>0</PaymentTermsDays>
<ReferenceLine1>String</ReferenceLine1>
<ReferenceLine2>String</ReferenceLine2>
<Street1>String</Street1>
<Street2>String</Street2>
<VatRegistrationNumber>String</VatRegistrationNumber>
<ZipCode>String</ZipCode>
</AddBillingInformation>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <BillingInformationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos"> <Attention>String</Attention> <BillingMethodId>0</BillingMethodId> <BillingMethodOptions xmlns:d2p1="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Db"> <d2p1:BillingMethod> <d2p1:BillingMethodCountriesRelation> <d2p1:BillingMethodCountriesRelation> <d2p1:BillingMethodId>0</d2p1:BillingMethodId> <d2p1:CountryId>String</d2p1:CountryId> <d2p1:ModifiedDate xmlns:d6p1="http://schemas.datacontract.org/2004/07/System"> <d6p1:DateTime>0001-01-01T00:00:00Z</d6p1:DateTime> <d6p1:OffsetMinutes>0</d6p1:OffsetMinutes> </d2p1:ModifiedDate> </d2p1:BillingMethodCountriesRelation> </d2p1:BillingMethodCountriesRelation> <d2p1:Description>String</d2p1:Description> <d2p1:Id>0</d2p1:Id> <d2p1:ModifiedDate xmlns:d4p1="http://schemas.datacontract.org/2004/07/System"> <d4p1:DateTime>0001-01-01T00:00:00Z</d4p1:DateTime> <d4p1:OffsetMinutes>0</d4p1:OffsetMinutes> </d2p1:ModifiedDate> <d2p1:Name>String</d2p1:Name> </d2p1:BillingMethod> </BillingMethodOptions> <City>String</City> <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId> <CountryId>String</CountryId> <Email>String</Email> <GLN>String</GLN> <Name>String</Name> <PaymentTermsDays>0</PaymentTermsDays> <ReferenceLine1>String</ReferenceLine1> <ReferenceLine2>String</ReferenceLine2> <Street1>String</Street1> <Street2>String</Street2> <VatRegistrationNumber>String</VatRegistrationNumber> <ZipCode>String</ZipCode> </BillingInformationResponse>