BokaMera.API.Host

<back to all web services

AddBillingInformation

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
POST/billing/company/Add new billing information.Add new billing information.
AddBillingInformation Parameters:
NameParameterData TypeRequiredDescription
CompanyIdbodyGuid?NoThe company id, if empty will use the company id for the user you are logged in with.
BillingMethodIdbodyintYesThe prefered billing method.
NamebodystringNoThe name that should be printed on the billing information, normally this would be your company name.
AttentionbodystringNoIf you want to add the attention to the billing address.
Street1bodystringNoThe street for the billing adress. This is required when having postal invoice as billing method.
Street2bodystringNoThe street for the billing adress.
ZipCodebodystringNoThe zip code (postal code) for the billing adress. This is required when having postal invoice as billing method.
CitybodystringNoThe city for the billing adress. This is required when having postal invoice as billing method.
CountryIdbodystringNoThe country for the billing adress. This is required when having postal invoice as billing method.
EmailbodystringNoThe billing email. This is required when having email invoice as billing method.
PaymentTermsDaysbodyint?NoThe billing payment terms in days. This is default 15 days.
VatRegistrationNumberbodystringNoThe company vat registration number.
GLNbodystringNoThe company global location number.
ReferenceLine1bodystringNoYou're internal rereference.
ReferenceLine2bodystringNoYou're internal rereference.
BillingInformationResponse Parameters:
NameParameterData TypeRequiredDescription
CompanyIdformGuidNoThe company id.
BillingMethodIdformintYesThe prefered billing method.
NameformstringNoThe name that should be printed on the billing information, normally this would be your company name.
AttentionformstringNoIf you want to add the attention to the billing address.
Street1formstringNoThe street for the billing adress. This is required when having postal invoice as billing method.
Street2formstringNoThe street for the billing adress.
ZipCodeformstringNoThe zip code (postal code) for the billing adress. This is required when having postal invoice as billing method.
CityformstringNoThe city for the billing adress. This is required when having postal invoice as billing method.
CountryIdformstringNoThe country for the billing adress. This is required when having postal invoice as billing method.
EmailformstringNoThe billing email. This is required when having email invoice as billing method.
GLNformstringNoThe company global location number.
ReferenceLine1formstringNoYou're internal rereference.
ReferenceLine2formstringNoYou're internal rereference.
PaymentTermsDaysformintNoThe billing payment terms in days. This is default 15 days.
VatRegistrationNumberformstringNoThe company vat registration number.
BillingMethodOptionsformList<BillingMethod>NoThe billing method options to choose from
BillingMethod Parameters:
NameParameterData TypeRequiredDescription
BillingMethodCountriesRelationformList<BillingMethodCountriesRelation>No
NameformstringYes
DescriptionformstringYes
ModifiedDateformDateTimeOffset?No
IdformintNo
BillingMethodCountriesRelation Parameters:
NameParameterData TypeRequiredDescription
BillingMethodIdformintYes
CountryIdformstringYes
ModifiedDateformDateTimeOffset?No

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: testapi.bokamera.se 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"CompanyId":"00000000-0000-0000-0000-000000000000","BillingMethodId":0,"Name":"String","Attention":"String","Street1":"String","Street2":"String","ZipCode":"String","City":"String","CountryId":"String","Email":"String","PaymentTermsDays":0,"VatRegistrationNumber":"String","GLN":"String","ReferenceLine1":"String","ReferenceLine2":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"BillingMethodId":0,"Name":"String","Attention":"String","Street1":"String","Street2":"String","ZipCode":"String","City":"String","CountryId":"String","Email":"String","GLN":"String","ReferenceLine1":"String","ReferenceLine2":"String","PaymentTermsDays":0,"VatRegistrationNumber":"String","BillingMethodOptions":[{"BillingMethodCountriesRelation":[{"BillingMethodId":0,"CountryId":"String","ModifiedDate":"0001-01-01T00:00:00.0000000+00:00"}],"Name":"String","Description":"String","ModifiedDate":"0001-01-01T00:00:00.0000000+00:00","Id":0}]}