ROSE Developers - Web API Reference

Sales | Billing Request

The billing requests end point is used to record information about order, return orders, delivery and goods receipt to be transformed to invoices or memos. RESERVED FOR INTERNAL USE.

Overview


URL api/{tenantKey}/{orgKey}/billing/billingRequests
Methods Supported GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

All Resources

This service uses the following resources:

All Enumerations

This service uses the following enumerations:

GET Operations

GET BillingRequests

Returns the list of all the entity records available.

Response:

When successful, the response body contains the list of records available. See BillingRequestResource.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

GET /billing/billingRequests

GET BillingRequests (paged)

Returns a page of the list of all the entity records available.

The following elements are optional:

page (int) The index of the page of the list that should be returned. This is a query string parameter.
pageSize (int) The number of page elements that should be returned (max. is 1000). This is a query string parameter.

Response:

When successful, the response body contains the list of records available. See BillingRequestResource.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

GET /billing/billingRequests?page={page}&pageSize={pageSize}

GET BillingRequest by identifier

Returns the entity record that matches the specified identifier.

The following elements are required:

id (string) The record identifier.

Response:

When successful, the response body contains the entity record. See BillingRequestResource.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.
404 NotFound. The specified record does not exist.

Resource URL:

GET /billing/billingRequests/{id}

GET BillingRequest by key

Returns the entity record that matches the specified key.

The following elements are required:

companyKey (string) The company key.
billingRequestKey (int) The billing request key.

Response:

When successful, the response body contains the entity record. See BillingRequestResource.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.
404 NotFound. The specified record does not exist.

Resource URL:

GET /billing/billingRequests/{companyKey}/{billingRequestKey}

GET Print BillingRequest by identifier

Prints the specified entity record.

The following elements are required:

id (string) The record identifier.

The following elements are optional:

template (string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200 OK. The operation was completed successfully.
404 NotFound. The specified resord does not exist.

Resource URL:

GET /billing/billingRequests/{id}/print?template={template}

GET Print BillingRequest by key

Prints the specified entity record.

The following elements are required:

companyKey (string) The company key.
billingRequestKey (int) The billing request key.

The following elements are optional:

template (string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.
404 NotFound. The specified record does not exist.

Resource URL:

GET /billing/billingRequests/{companyKey}/{billingRequestKey}/print

GET Original Print BillingRequestOriginal by identifier

Prints the specified entity record.

The following elements are required:

id (string) The record identifier.

The following elements are optional:

template (string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200 OK. The operation was completed successfully.
404 NotFound. The specified resord does not exist.

Resource URL:

GET /billing/billingRequests/{id}/printOriginal?template={template}

GET Original Print BillingRequest by key

Prints the specified entity record.

The following elements are required:

companyKey (string) The company key.
billingRequestKey (int) The billing request key.

The following elements are optional:

template (string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.
404 NotFound. The specified record does not exist.

Resource URL:

GET /billing/billingRequests/{companyKey}/{billingRequestKey}/printOriginal

POST Operations

POST BillingRequests

Creates a new entity record.

The following elements are required:

billingRequestResource (ApiBillingRequestResource) The request body should contain the entity record that should be created.
See ApiBillingRequestResource.

Response:

When successful, the response body contains the new entity record identifier. The resource header location property contains the URL for the new entity record. See ApiBillingRequestResource.

Response status codes:

201 Created. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

POST /billing/billingRequests

POST Billing Request

Inserts a new 'Billing Request Line' in the 'Billing Request'.

The following elements are required:

billingRequestKey (int) The billing request key.
companyKey (string) The company key.
value (ApiBillingRequestBillingRequestLinesResource) The ApiBillingRequestBillingRequestLinesResource instance.
See ApiBillingRequestBillingRequestLinesResource.

Response:

When successful, the response body is empty.

Response status codes:

204 NoContent. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

POST /billing/billingRequests/{companyKey}/{billingRequestKey}/billingRequestLines

PUT Operations

PUT Set AccountingAltAddress BillingRequest

Updates the value of attribute 'AccountingAltAddress' in the specified entity record.

The following elements are required:

billingRequestKey (int) The billing request key.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /billing/billingRequests/{companyKey}/{billingRequestKey}/accountingAltAddress

PUT Set AccountingParty BillingRequest

Updates the value of attribute 'AccountingParty' in the specified entity record.

The following elements are required:

billingRequestKey (int) The billing request key.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /billing/billingRequests/{companyKey}/{billingRequestKey}/accountingParty

PUT Set AccountingPartyAddress BillingRequest

Updates the value of attribute 'AccountingPartyAddress' in the specified entity record.

The following elements are required:

billingRequestKey (int) The billing request key.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /billing/billingRequests/{companyKey}/{billingRequestKey}/accountingPartyAddress

PUT Set AccountingPartyName BillingRequest

Updates the value of attribute 'AccountingPartyName' in the specified entity record.

The following elements are required:

billingRequestKey (int) The billing request key.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /billing/billingRequests/{companyKey}/{billingRequestKey}/accountingPartyName

PUT Set AccountingPartyTaxId BillingRequest

Updates the value of attribute 'AccountingPartyTaxId' in the specified entity record.

The following elements are required:

billingRequestKey (int) The billing request key.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /billing/billingRequests/{companyKey}/{billingRequestKey}/accountingPartyTaxId

PUT Set AltAddress BillingRequest

Updates the value of attribute 'AltAddress' in the specified entity record.

The following elements are required:

billingRequestKey (int) The billing request key.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /billing/billingRequests/{companyKey}/{billingRequestKey}/altAddress

PUT Set BillingRequestDate BillingRequest

Updates the value of attribute 'BillingRequestDate' in the specified entity record.

The following elements are required:

billingRequestKey (int) The billing request key.
companyKey (string) The company key.
value (DateTime) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /billing/billingRequests/{companyKey}/{billingRequestKey}/billingRequestDate

PUT Set BillingRequestKey BillingRequest

Updates the value of attribute 'BillingRequestKey' in the specified entity record.

The following elements are required:

billingRequestKey (int) The billing request key.
companyKey (string) The company key.
value (int) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /billing/billingRequests/{companyKey}/{billingRequestKey}/billingRequestKey

PUT Set BuyerCustomerPartyAddress BillingRequest

Updates the value of attribute 'BuyerCustomerPartyAddress' in the specified entity record.

The following elements are required:

billingRequestKey (int) The billing request key.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /billing/billingRequests/{companyKey}/{billingRequestKey}/buyerCustomerPartyAddress

PUT Set BuyerCustomerPartyName BillingRequest

Updates the value of attribute 'BuyerCustomerPartyName' in the specified entity record.

The following elements are required:

billingRequestKey (int) The billing request key.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /billing/billingRequests/{companyKey}/{billingRequestKey}/buyerCustomerPartyName

PUT Set BuyerCustomerPartyTaxId BillingRequest

Updates the value of attribute 'BuyerCustomerPartyTaxId' in the specified entity record.

The following elements are required:

billingRequestKey (int) The billing request key.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /billing/billingRequests/{companyKey}/{billingRequestKey}/buyerCustomerPartyTaxId

PUT Set CommitmentReference BillingRequestLine

Updates the value of attribute 'CommitmentReference' in the specified entity record.

The following elements are required:

billingRequestKey (int) The billing request key.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /billing/billingRequests/{companyKey}/{billingRequestKey}/billingRequestLines/{lineId}/commitmentReference

PUT Set Company BillingRequest

Updates the value of attribute 'Company' in the specified entity record.

The following elements are required:

billingRequestKey (int) The billing request key.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /billing/billingRequests/{companyKey}/{billingRequestKey}/company

PUT Set ComplementaryDescription BillingRequestLine

Updates the value of attribute 'ComplementaryDescription' in the specified entity record.

The following elements are required:

billingRequestKey (int) The billing request key.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /billing/billingRequests/{companyKey}/{billingRequestKey}/billingRequestLines/{lineId}/complementaryDescription

PUT Set Currency BillingRequest

Updates the value of attribute 'Currency' in the specified entity record.

The following elements are required:

billingRequestKey (int) The billing request key.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /billing/billingRequests/{companyKey}/{billingRequestKey}/currency

PUT Set Currency BillingRequestLine

Updates the value of attribute 'Currency' in the specified entity record.

The following elements are required:

billingRequestKey (int) The billing request key.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /billing/billingRequests/{companyKey}/{billingRequestKey}/billingRequestLines/{lineId}/currency

PUT Set CustomAttributes BillingRequest

Updates the value of attribute 'CustomAttributes' in the specified entity record.

The following elements are required:

billingRequestKey (int) The billing request key.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /billing/billingRequests/{companyKey}/{billingRequestKey}/customAttributes

PUT Set CustomAttributes BillingRequestLine

Updates the value of attribute 'CustomAttributes' in the specified entity record.

The following elements are required:

billingRequestKey (int) The billing request key.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /billing/billingRequests/{companyKey}/{billingRequestKey}/billingRequestLines/{lineId}/customAttributes

PUT Set Delivery BillingRequest

Updates the value of attribute 'Delivery' in the specified entity record.

The following elements are required:

billingRequestKey (int) The billing request key.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /billing/billingRequests/{companyKey}/{billingRequestKey}/delivery

PUT Set Delivery BillingRequestLine

Updates the value of attribute 'Delivery' in the specified entity record.

The following elements are required:

billingRequestKey (int) The billing request key.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /billing/billingRequests/{companyKey}/{billingRequestKey}/billingRequestLines/{lineId}/delivery

PUT Set DeliveryId BillingRequest

Updates the value of attribute 'DeliveryId' in the specified entity record.

The following elements are required:

billingRequestKey (int) The billing request key.
companyKey (string) The company key.
value (Guid) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /billing/billingRequests/{companyKey}/{billingRequestKey}/deliveryId

PUT Set DeliveryId BillingRequestLine

Updates the value of attribute 'DeliveryId' in the specified entity record.

The following elements are required:

billingRequestKey (int) The billing request key.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (Guid) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /billing/billingRequests/{companyKey}/{billingRequestKey}/billingRequestLines/{lineId}/deliveryId

PUT Set DeliveryLine BillingRequestLine

Updates the value of attribute 'DeliveryLine' in the specified entity record.

The following elements are required:

billingRequestKey (int) The billing request key.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (int) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /billing/billingRequests/{companyKey}/{billingRequestKey}/billingRequestLines/{lineId}/deliveryLine

PUT Set DeliveryLineId BillingRequestLine

Updates the value of attribute 'DeliveryLineId' in the specified entity record.

The following elements are required:

billingRequestKey (int) The billing request key.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (Guid) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /billing/billingRequests/{companyKey}/{billingRequestKey}/billingRequestLines/{lineId}/deliveryLineId

PUT Set DeliveryMode BillingRequest

Updates the value of attribute 'DeliveryMode' in the specified entity record.

The following elements are required:

billingRequestKey (int) The billing request key.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /billing/billingRequests/{companyKey}/{billingRequestKey}/deliveryMode

PUT Set DeliverySchemaEntity BillingRequestLine

Updates the value of attribute 'DeliverySchemaEntity' in the specified entity record.

The following elements are required:

billingRequestKey (int) The billing request key.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /billing/billingRequests/{companyKey}/{billingRequestKey}/billingRequestLines/{lineId}/deliverySchemaEntity

PUT Set DeliveryTerm BillingRequest

Updates the value of attribute 'DeliveryTerm' in the specified entity record.

The following elements are required:

billingRequestKey (int) The billing request key.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /billing/billingRequests/{companyKey}/{billingRequestKey}/deliveryTerm

PUT Set Description BillingRequestLine

Updates the value of attribute 'Description' in the specified entity record.

The following elements are required:

billingRequestKey (int) The billing request key.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /billing/billingRequests/{companyKey}/{billingRequestKey}/billingRequestLines/{lineId}/description

PUT Set DimensionSet BillingRequest

Updates the value of attribute 'DimensionSet' in the specified entity record.

The following elements are required:

billingRequestKey (int) The billing request key.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /billing/billingRequests/{companyKey}/{billingRequestKey}/dimensionSet

PUT Set DimensionSet BillingRequestLine

Updates the value of attribute 'DimensionSet' in the specified entity record.

The following elements are required:

billingRequestKey (int) The billing request key.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /billing/billingRequests/{companyKey}/{billingRequestKey}/billingRequestLines/{lineId}/dimensionSet

PUT Set Discount BillingRequest

Updates the value of attribute 'Discount' in the specified entity record.

The following elements are required:

billingRequestKey (int) The billing request key.
companyKey (string) The company key.
value (decimal) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /billing/billingRequests/{companyKey}/{billingRequestKey}/discount

PUT Set Discount1 BillingRequestLine

Updates the value of attribute 'Discount1' in the specified entity record.

The following elements are required:

billingRequestKey (int) The billing request key.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (decimal) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /billing/billingRequests/{companyKey}/{billingRequestKey}/billingRequestLines/{lineId}/discount1

PUT Set Discount2 BillingRequestLine

Updates the value of attribute 'Discount2' in the specified entity record.

The following elements are required:

billingRequestKey (int) The billing request key.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (decimal) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /billing/billingRequests/{companyKey}/{billingRequestKey}/billingRequestLines/{lineId}/discount2

PUT Set Discount3 BillingRequestLine

Updates the value of attribute 'Discount3' in the specified entity record.

The following elements are required:

billingRequestKey (int) The billing request key.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (decimal) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /billing/billingRequests/{companyKey}/{billingRequestKey}/billingRequestLines/{lineId}/discount3

PUT Set DocumentLineStatus BillingRequestLine

Updates the value of attribute 'DocumentLineStatus' in the specified entity record.

The following elements are required:

billingRequestKey (int) The billing request key.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (enum DocumentLineStatus) The request body should contain the new value for the attribute.
See DocumentLineStatus.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /billing/billingRequests/{companyKey}/{billingRequestKey}/billingRequestLines/{lineId}/documentLineStatus

PUT Set DocumentStatus BillingRequest

Updates the value of attribute 'DocumentStatus' in the specified entity record.

The following elements are required:

billingRequestKey (int) The billing request key.
companyKey (string) The company key.
value (enum DocumentStatus) The request body should contain the new value for the attribute.
See DocumentStatus.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /billing/billingRequests/{companyKey}/{billingRequestKey}/documentStatus

PUT Set EconomicActivityClassification BillingRequest

Updates the value of attribute 'EconomicActivityClassification' in the specified entity record.

The following elements are required:

billingRequestKey (int) The billing request key.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /billing/billingRequests/{companyKey}/{billingRequestKey}/economicActivityClassification

PUT Set InvoiceType BillingRequest

Updates the value of attribute 'InvoiceType' in the specified entity record.

The following elements are required:

billingRequestKey (int) The billing request key.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /billing/billingRequests/{companyKey}/{billingRequestKey}/invoiceType

PUT Set IsActive BillingRequest

Updates the value of attribute 'IsActive' in the specified entity record.

The following elements are required:

billingRequestKey (int) The billing request key.
companyKey (string) The company key.
value (bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.
404 NotFound. The specified record does not exist.

Resource URL:

PUT /billing/billingRequests/{companyKey}/{billingRequestKey}/isActive

PUT Set ItemTaxSchema BillingRequestLine

Updates the value of attribute 'ItemTaxSchema' in the specified entity record.

The following elements are required:

billingRequestKey (int) The billing request key.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /billing/billingRequests/{companyKey}/{billingRequestKey}/billingRequestLines/{lineId}/itemTaxSchema

PUT Set LoadingBuildingNumber BillingRequest

Updates the value of attribute 'LoadingBuildingNumber' in the specified entity record.

The following elements are required:

billingRequestKey (int) The billing request key.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /billing/billingRequests/{companyKey}/{billingRequestKey}/loadingBuildingNumber

PUT Set LoadingCityName BillingRequest

Updates the value of attribute 'LoadingCityName' in the specified entity record.

The following elements are required:

billingRequestKey (int) The billing request key.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /billing/billingRequests/{companyKey}/{billingRequestKey}/loadingCityName

PUT Set LoadingCountry BillingRequest

Updates the value of attribute 'LoadingCountry' in the specified entity record.

The following elements are required:

billingRequestKey (int) The billing request key.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /billing/billingRequests/{companyKey}/{billingRequestKey}/loadingCountry

PUT Set LoadingPoint BillingRequest

Updates the value of attribute 'LoadingPoint' in the specified entity record.

The following elements are required:

billingRequestKey (int) The billing request key.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /billing/billingRequests/{companyKey}/{billingRequestKey}/loadingPoint

PUT Set LoadingPointAddress BillingRequest

Updates the value of attribute 'LoadingPointAddress' in the specified entity record.

The following elements are required:

billingRequestKey (int) The billing request key.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /billing/billingRequests/{companyKey}/{billingRequestKey}/loadingPointAddress

PUT Set LoadingPostalZone BillingRequest

Updates the value of attribute 'LoadingPostalZone' in the specified entity record.

The following elements are required:

billingRequestKey (int) The billing request key.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /billing/billingRequests/{companyKey}/{billingRequestKey}/loadingPostalZone

PUT Set LoadingStreetName BillingRequest

Updates the value of attribute 'LoadingStreetName' in the specified entity record.

The following elements are required:

billingRequestKey (int) The billing request key.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /billing/billingRequests/{companyKey}/{billingRequestKey}/loadingStreetName

PUT Set MemoType BillingRequest

Updates the value of attribute 'MemoType' in the specified entity record.

The following elements are required:

billingRequestKey (int) The billing request key.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /billing/billingRequests/{companyKey}/{billingRequestKey}/memoType

PUT Set PartyTaxSchema BillingRequestLine

Updates the value of attribute 'PartyTaxSchema' in the specified entity record.

The following elements are required:

billingRequestKey (int) The billing request key.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /billing/billingRequests/{companyKey}/{billingRequestKey}/billingRequestLines/{lineId}/partyTaxSchema

PUT Set PaymentMethod BillingRequest

Updates the value of attribute 'PaymentMethod' in the specified entity record.

The following elements are required:

billingRequestKey (int) The billing request key.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /billing/billingRequests/{companyKey}/{billingRequestKey}/paymentMethod

PUT Set PaymentTerm BillingRequest

Updates the value of attribute 'PaymentTerm' in the specified entity record.

The following elements are required:

billingRequestKey (int) The billing request key.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /billing/billingRequests/{companyKey}/{billingRequestKey}/paymentTerm

PUT Set Quantity BillingRequestLine

Updates the value of attribute 'Quantity' in the specified entity record.

The following elements are required:

billingRequestKey (int) The billing request key.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (decimal) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /billing/billingRequests/{companyKey}/{billingRequestKey}/billingRequestLines/{lineId}/quantity

PUT Set Reference BillingRequestLine

Updates the value of attribute 'Reference' in the specified entity record.

The following elements are required:

billingRequestKey (int) The billing request key.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /billing/billingRequests/{companyKey}/{billingRequestKey}/billingRequestLines/{lineId}/reference

PUT Set SalesItem BillingRequestLine

Updates the value of attribute 'SalesItem' in the specified entity record.

The following elements are required:

billingRequestKey (int) The billing request key.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /billing/billingRequests/{companyKey}/{billingRequestKey}/billingRequestLines/{lineId}/salesItem

PUT Set Salesperson BillingRequest

Updates the value of attribute 'Salesperson' in the specified entity record.

The following elements are required:

billingRequestKey (int) The billing request key.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /billing/billingRequests/{companyKey}/{billingRequestKey}/salesperson

PUT Set SourceDoc BillingRequest

Updates the value of attribute 'SourceDoc' in the specified entity record.

The following elements are required:

billingRequestKey (int) The billing request key.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /billing/billingRequests/{companyKey}/{billingRequestKey}/sourceDoc

PUT Set SourceDoc BillingRequestLine

Updates the value of attribute 'SourceDoc' in the specified entity record.

The following elements are required:

billingRequestKey (int) The billing request key.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /billing/billingRequests/{companyKey}/{billingRequestKey}/billingRequestLines/{lineId}/sourceDoc

PUT Set SourceDocDate BillingRequest

Updates the value of attribute 'SourceDocDate' in the specified entity record.

The following elements are required:

billingRequestKey (int) The billing request key.
companyKey (string) The company key.
value (DateTimeOffset) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /billing/billingRequests/{companyKey}/{billingRequestKey}/sourceDocDate

PUT Set SourceDocId BillingRequest

Updates the value of attribute 'SourceDocId' in the specified entity record.

The following elements are required:

billingRequestKey (int) The billing request key.
companyKey (string) The company key.
value (Guid) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /billing/billingRequests/{companyKey}/{billingRequestKey}/sourceDocId

PUT Set SourceDocId BillingRequestLine

Updates the value of attribute 'SourceDocId' in the specified entity record.

The following elements are required:

billingRequestKey (int) The billing request key.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (Guid) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /billing/billingRequests/{companyKey}/{billingRequestKey}/billingRequestLines/{lineId}/sourceDocId

PUT Set SourceDocLine BillingRequestLine

Updates the value of attribute 'SourceDocLine' in the specified entity record.

The following elements are required:

billingRequestKey (int) The billing request key.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (int) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /billing/billingRequests/{companyKey}/{billingRequestKey}/billingRequestLines/{lineId}/sourceDocLine

PUT Set SourceDocLineId BillingRequestLine

Updates the value of attribute 'SourceDocLineId' in the specified entity record.

The following elements are required:

billingRequestKey (int) The billing request key.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (Guid) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /billing/billingRequests/{companyKey}/{billingRequestKey}/billingRequestLines/{lineId}/sourceDocLineId

PUT Set SourceDocNature BillingRequestLine

Updates the value of attribute 'SourceDocNature' in the specified entity record.

The following elements are required:

billingRequestKey (int) The billing request key.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (enum OrderNature) The request body should contain the new value for the attribute.
See OrderNature.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /billing/billingRequests/{companyKey}/{billingRequestKey}/billingRequestLines/{lineId}/sourceDocNature

PUT Set SourceOrder BillingRequestLine

Updates the value of attribute 'SourceOrder' in the specified entity record.

The following elements are required:

billingRequestKey (int) The billing request key.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /billing/billingRequests/{companyKey}/{billingRequestKey}/billingRequestLines/{lineId}/sourceOrder

PUT Set SourceOrderId BillingRequestLine

Updates the value of attribute 'SourceOrderId' in the specified entity record.

The following elements are required:

billingRequestKey (int) The billing request key.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (Guid) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /billing/billingRequests/{companyKey}/{billingRequestKey}/billingRequestLines/{lineId}/sourceOrderId

PUT Set SourceOrderLine BillingRequestLine

Updates the value of attribute 'SourceOrderLine' in the specified entity record.

The following elements are required:

billingRequestKey (int) The billing request key.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (int) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /billing/billingRequests/{companyKey}/{billingRequestKey}/billingRequestLines/{lineId}/sourceOrderLine

PUT Set SourceOrderLineId BillingRequestLine

Updates the value of attribute 'SourceOrderLineId' in the specified entity record.

The following elements are required:

billingRequestKey (int) The billing request key.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (Guid) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /billing/billingRequests/{companyKey}/{billingRequestKey}/billingRequestLines/{lineId}/sourceOrderLineId

PUT Set SourceOrderSchemaEntityId BillingRequestLine

Updates the value of attribute 'SourceOrderSchemaEntityId' in the specified entity record.

The following elements are required:

billingRequestKey (int) The billing request key.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (Guid) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /billing/billingRequests/{companyKey}/{billingRequestKey}/billingRequestLines/{lineId}/sourceOrderSchemaEntityId

PUT Set SourceSchemaEntity BillingRequestLine

Updates the value of attribute 'SourceSchemaEntity' in the specified entity record.

The following elements are required:

billingRequestKey (int) The billing request key.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /billing/billingRequests/{companyKey}/{billingRequestKey}/billingRequestLines/{lineId}/sourceSchemaEntity

PUT Set TaxIncluded BillingRequest

Updates the value of attribute 'TaxIncluded' in the specified entity record.

The following elements are required:

billingRequestKey (int) The billing request key.
companyKey (string) The company key.
value (bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /billing/billingRequests/{companyKey}/{billingRequestKey}/taxIncluded

PUT Set Unit BillingRequestLine

Updates the value of attribute 'Unit' in the specified entity record.

The following elements are required:

billingRequestKey (int) The billing request key.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /billing/billingRequests/{companyKey}/{billingRequestKey}/billingRequestLines/{lineId}/unit

PUT Set UnitPrice BillingRequestLine

Updates the value of attribute 'UnitPrice' in the specified entity record.

The following elements are required:

billingRequestKey (int) The billing request key.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (decimal) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /billing/billingRequests/{companyKey}/{billingRequestKey}/billingRequestLines/{lineId}/unitPrice

PUT Set UnloadingBuildingNumber BillingRequest

Updates the value of attribute 'UnloadingBuildingNumber' in the specified entity record.

The following elements are required:

billingRequestKey (int) The billing request key.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /billing/billingRequests/{companyKey}/{billingRequestKey}/unloadingBuildingNumber

PUT Set UnloadingCityName BillingRequest

Updates the value of attribute 'UnloadingCityName' in the specified entity record.

The following elements are required:

billingRequestKey (int) The billing request key.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /billing/billingRequests/{companyKey}/{billingRequestKey}/unloadingCityName

PUT Set UnloadingCountry BillingRequest

Updates the value of attribute 'UnloadingCountry' in the specified entity record.

The following elements are required:

billingRequestKey (int) The billing request key.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /billing/billingRequests/{companyKey}/{billingRequestKey}/unloadingCountry

PUT Set UnloadingPoint BillingRequest

Updates the value of attribute 'UnloadingPoint' in the specified entity record.

The following elements are required:

billingRequestKey (int) The billing request key.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /billing/billingRequests/{companyKey}/{billingRequestKey}/unloadingPoint

PUT Set UnloadingPointAddress BillingRequest

Updates the value of attribute 'UnloadingPointAddress' in the specified entity record.

The following elements are required:

billingRequestKey (int) The billing request key.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /billing/billingRequests/{companyKey}/{billingRequestKey}/unloadingPointAddress

PUT Set UnloadingPostalZone BillingRequest

Updates the value of attribute 'UnloadingPostalZone' in the specified entity record.

The following elements are required:

billingRequestKey (int) The billing request key.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /billing/billingRequests/{companyKey}/{billingRequestKey}/unloadingPostalZone

PUT Set UnloadingStreetName BillingRequest

Updates the value of attribute 'UnloadingStreetName' in the specified entity record.

The following elements are required:

billingRequestKey (int) The billing request key.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /billing/billingRequests/{companyKey}/{billingRequestKey}/unloadingStreetName

PUT Set Warehouse BillingRequestLine

Updates the value of attribute 'Warehouse' in the specified entity record.

The following elements are required:

billingRequestKey (int) The billing request key.
lineId (string) The detail identifier.
companyKey (string) The company key.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /billing/billingRequests/{companyKey}/{billingRequestKey}/billingRequestLines/{lineId}/warehouse

DELETE Operations

DELETE Billing Request Line by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

billingRequestKey (int) The billing request key.
companyKey (string) The company key.
lineId (string) The line identifier.

Response:

When successful, the response body is empty.

Response status codes:

204 NoContent. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.
404 NotFound. The specified record does not exist.

Resource URL:

DELETE /billing/billingRequests/{companyKey}/{billingRequestKey}/billingRequestLines/{lineId}

DELETE BillingRequest by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

id (string) The record identifier.

Response:

When successful, the response body is empty.

Response status codes:

204 Deleted. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.
404 NotFound. The specified record does not exist.

Resource URL:

DELETE /billing/billingRequests/{id}

DELETE BillingRequest by key

Deletes the entity record that matches the specified key.

The following elements are required:

companyKey (string) The company key.
billingRequestKey (int) The billing request key.

Response:

When successful, the response body is empty.

Response status codes:

204 Deleted. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.
404 NotFound. The specified record does not exist.

Resource URL:

DELETE /billing/billingRequests/{companyKey}/{billingRequestKey}

Resources


ApiBillingRequestBillingRequestLinesResource

The following elements are required:

salesItem (string) The sales item representing the good or service.
unitPrice (MoneyResource) The document's line item unit price. The default price is loaded from sales item prices when there is a match on the combination of price list, currency, tax included and unit.
See MoneyResource .
unit (string) The document's line item sales unit. The default sales unit is defined on the sales item.
partyTaxSchema (string) The document's customer party tax schema. The tax schema identifies the group of taxes a party is liable for. The tax schema is defined in the customer party.
itemTaxSchema (string) The document's line item tax schema. The tax schema identifies the group of taxes a item is liable for. The default tax schema is defined on the sales item.
currency (string) The money’s unit. Inferred from the document currency.

The following elements are optional:

description (string) The document's line item description. The default is defined on the sales item.
complementaryDescription (string) The document's line item complementary description. The default is defined on the sales item.
quantity (decimal) The document's line item quantity. The default 1.
discount1 (decimal) The line's item discount 1 percentage. The default is 0.
discount2 (decimal) The line's item discount 2 percentage. The default is 0.
discount3 (decimal) The line's item discount 3 percentage. The default is 0.
warehouse (string) The document's line item warehouse. The default is defined on the materials item.
documentLineStatus (enum DocumentLineStatus) The document's line status. The default is Open.
See DocumentLineStatus.
sourceSchemaEntity (string) The source schema entity.
sourceDoc (string) The original document identification.
sourceDocId (Guid) The source document id.
sourceDocLine (int) The source doc line number.
sourceDocLineId (Guid) The source doc line identification.
sourceDocNature (enum OrderNature) The nature of the source document. Infered from the original document.
See OrderNature.
deliverySchemaEntity (string) The delevery schema entity.
delivery (string) The delivery.
deliveryId (Guid) The delivery id.
deliveryLine (int) The delivery line.
deliveryLineId (Guid) The delivery line id.
reference (string) This field is populated with the sales document number when it comes from the return process.
sourceOrder (string) The order that origin this line.
sourceOrderId (Guid) The order id that origin this line.
sourceOrderLine (int) The order line index that origin this line.
sourceOrderLineId (Guid) The order line id that origin this line.
sourceOrderSchemaEntityId (Guid) The order schema id that origin this line.
dimensionSet (string) Dimension Set.
commitmentReference (string) The state supplier commitment reference.
customAttributes (string) The order line custom attributes.


ApiBillingRequestResource

The following elements are required:

billingRequestKey (int) The billing request key.
company (string) The billing request company. The company code is the central organizational unit within the system.
currency (string) The currency of the billing request.
accountingParty (string) The customer designated in the document as the party to whom the invoice should be sent for payment.
paymentMethod (string) The document payment method. Financial transfer method used by the entity responsible for paying a transaction. For example, cash, transfer or check payments. The default is defined on the customer party.
paymentTerm (string) The document payment term. Term specifying the manner in which a trade will be done. Generally, these terms specify a period in which the buyer can pay the due amount. They can also demand some money to be paid in advance, paid in cash at delivery, a 30 day or longer period, or other similar arrangements for deferred payment. The default is defined on the customer party.
buyerCustomerParty (string) The customer party.
sourceSchemaEntity (string) The source schema entity.

The following elements are optional:

invoiceType (string) Is not null if the document request is from a invoice and define the type of invoice.
memoType (string) Is not null if the document request is from a memo and define the type of memo.
deliveryTerm (string) The document delivery term. The conditions in a sales or transportation contract that specify the means of transportation.
buyerCustomerPartyName (string) The customer's name. It is infered from the customer party.
buyerCustomerPartyTaxId (string) The customer's tax code. Unique code assigned by a country's tax authority to establish an entity's fiscal identification and responsibilities. Infered from the customer party.
buyerCustomerPartyAddress (string) The customer's address. It is infered from the customer party.
accountingPartyName (string) The accounting's party name. It is inferred from the accounting party.
accountingPartyTaxId (string) The accounting's tax code. Unique code assigned by a country's tax authority to establish an entity's fiscal identification and responsibilities. Inferred from the accounting party.
accountingPartyAddress (string) The accounting's customer address. It is inferred from the accounting party.
discount (decimal) The discount given in the document.
taxIncluded (bool) Indicates whether the unit prices have taxes included or not. The value is inferred from the memo series.
economicActivityClassification (string) The document's economic activity classification. A national legal standard that attributes a 5-digit value to identify a company's specific category of professional activity.
billingRequestLines (List of ApiBillingRequestBillingRequestLinesResource) The billing request lines.
See ApiBillingRequestBillingRequestLinesResource.
documentStatus (enum DocumentStatus) The document's status. Internally determined.
See DocumentStatus.
billingRequestDate (DateTime) The date of the billing request,.
loadingPoint (string) The physical location where the goods are loaded.
loadingPointAddress (string) The physical location address where the goods are loaded.
loadingStreetName (string) The street name of the physical location where the goods are loaded.
loadingBuildingNumber (string) The building number of the physical location where the goods are loaded.
loadingPostalZone (string) The postal zone of the physical location where the goods are loaded.
loadingCityName (string) The city of the physical location where the goods are loaded.
loadingCountry (string) The country of the physical location where the goods are loaded.
unloadingPoint (string) The physical location where the goods are unloaded. Defines the unloading from the freight.
unloadingPointAddress (string) The physical location address where the goods are unloaded.
unloadingStreetName (string) The street name of the physical location where the goods are unloaded.
unloadingBuildingNumber (string) The building number of the physical location where the goods are unloaded.
unloadingPostalZone (string) The postal zone of the physical location where the goods are unloaded.
unloadingCityName (string) The city name of the physical location where the goods are unloaded.
unloadingCountry (string) The country of the physical location where the goods are unloaded.
sourceDoc (string) The source document.
sourceDocId (Guid) The source document id.
sourceDocDate (DateTimeOffset) The source document date. Internally determined.
delivery (string) The delivery.
deliveryId (Guid) The delivery id.
altAddress (string) The alternative address.
accountingAltAddress (string) The accounting alternative address.
deliveryMode (string) The Delivery mode. (ex: mail).
salesperson (string) The sales person.
dimensionSet (string) Dimension Set.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice type.
noteToRecipient (string) The note to the invoice recipient.
remarks (string) The document’s remarks.
documentDate (DateTime) The document's date.
customAttributes (string) The order custom attributes.


BillingRequestLineResource

The following elements are required:

salesItem (string) The sales item representing the good or service.
unitPrice (MoneyResource) The document's line item unit price. The default price is loaded from sales item prices when there is a match on the combination of price list, currency, tax included and unit.
See MoneyResource .
unit (string) The document's line item sales unit. The default sales unit is defined on the sales item.
partyTaxSchema (string) The document's customer party tax schema. The tax schema identifies the group of taxes a party is liable for. The tax schema is defined in the customer party.
itemTaxSchema (string) The document's line item tax schema. The tax schema identifies the group of taxes a item is liable for. The default tax schema is defined on the sales item.
currency (string) The money’s unit. Inferred from the document currency.
itemType (enum ItemType) The document's line item type. Inferred from the sales item type. Internally determined.
See ItemType.
deliveryOnInvoice (bool) The default delivery type when the orders are processed.

The following elements are optional:

description (string) The document's line item description. The default is defined on the sales item.
complementaryDescription (string) The document's line item complementary description. The default is defined on the sales item.
quantity (decimal) The document's line item quantity. The default 1.
discount1 (decimal) The line's item discount 1 percentage. The default is 0.
discount2 (decimal) The line's item discount 2 percentage. The default is 0.
discount3 (decimal) The line's item discount 3 percentage. The default is 0.
warehouse (string) The document's line item warehouse. The default is defined on the materials item.
documentLineStatus (enum DocumentLineStatus) The document's line status. The default is Open.
See DocumentLineStatus.
sourceSchemaEntity (string) The source schema entity.
sourceDoc (string) The original document identification.
sourceDocId (Guid) The source document id.
sourceDocLine (int) The source doc line number.
sourceDocLineId (Guid) The source doc line identification.
sourceDocNature (enum OrderNature) The nature of the source document. Infered from the original document.
See OrderNature.
deliverySchemaEntity (string) The delevery schema entity.
delivery (string) The delivery.
deliveryId (Guid) The delivery id.
deliveryLine (int) The delivery line.
deliveryLineId (Guid) The delivery line id.
reference (string) This field is populated with the sales document number when it comes from the return process.
sourceOrder (string) The order that origin this line.
sourceOrderId (Guid) The order id that origin this line.
sourceOrderLine (int) The order line index that origin this line.
sourceOrderLineId (Guid) The order line id that origin this line.
sourceOrderSchemaEntityId (Guid) The order schema id that origin this line.
dimensionSet (string) Dimension Set.
commitmentReference (string) The state supplier commitment reference.
customAttributes (string) The order line custom attributes.


BillingRequestResource

The following elements are required:

billingRequestKey (int) The billing request key.
company (string) The billing request company. The company code is the central organizational unit within the system.
(fk) Allowed value: the natural key of a record of type Company. These records are accessibly through the Companies service.
currency (string) The currency of the billing request.
(fk) Allowed value: the natural key of a record of type Currency. These records are accessibly through the Currencies service.
accountingParty (string) The customer designated in the document as the party to whom the invoice should be sent for payment.
(fk) Allowed value: the natural key of a record of type Party. These records are accessibly through the Parties service.
paymentMethod (string) The document payment method. Financial transfer method used by the entity responsible for paying a transaction. For example, cash, transfer or check payments. The default is defined on the customer party.
(fk) Allowed value: the natural key of a record of type PaymentMethod. These records are accessibly through the PaymentMethods service.
paymentTerm (string) The document payment term. Term specifying the manner in which a trade will be done. Generally, these terms specify a period in which the buyer can pay the due amount. They can also demand some money to be paid in advance, paid in cash at delivery, a 30 day or longer period, or other similar arrangements for deferred payment. The default is defined on the customer party.
(fk) Allowed value: the natural key of a record of type PaymentTerm. These records are accessibly through the PaymentTerms service.
buyerCustomerParty (string) The customer party.
(fk) Allowed value: the natural key of a record of type Party. These records are accessibly through the Parties service.
sourceSchemaEntity (string) The source schema entity.
(fk) Allowed value: the natural key of a record of type SchemaEntity. These records are accessibly through the SchemaEntities service.

The following elements are optional:

invoiceType (string) Is not null if the document request is from a invoice and define the type of invoice.
(fk) Allowed value: the natural key of a record of type InvoiceType. These records are accessibly through the InvoiceTypes service.
memoType (string) Is not null if the document request is from a memo and define the type of memo.
(fk) Allowed value: the natural key of a record of type MemoType. These records are accessibly through the MemoTypes service.
deliveryTerm (string) The document delivery term. The conditions in a sales or transportation contract that specify the means of transportation.
(fk) Allowed value: the natural key of a record of type DeliveryTerm. These records are accessibly through the DeliveryTerms service.
buyerCustomerPartyName (string) The customer's name. It is infered from the customer party.
buyerCustomerPartyTaxId (string) The customer's tax code. Unique code assigned by a country's tax authority to establish an entity's fiscal identification and responsibilities. Infered from the customer party.
buyerCustomerPartyAddress (string) The customer's address. It is infered from the customer party.
accountingPartyName (string) The accounting's party name. It is inferred from the accounting party.
accountingPartyTaxId (string) The accounting's tax code. Unique code assigned by a country's tax authority to establish an entity's fiscal identification and responsibilities. Inferred from the accounting party.
accountingPartyAddress (string) The accounting's customer address. It is inferred from the accounting party.
discount (decimal) The discount given in the document.
taxIncluded (bool) Indicates whether the unit prices have taxes included or not. The value is inferred from the memo series.
economicActivityClassification (string) The document's economic activity classification. A national legal standard that attributes a 5-digit value to identify a company's specific category of professional activity.
(fk) Allowed value: the natural key of a record of type EconomicActivityClassification. These records are accessibly through the EconomicActivityClassifications service.
billingRequestLines (List of BillingRequestLineResource) The billing request lines.
See BillingRequestLineResource.
documentStatus (enum DocumentStatus) The document's status. Internally determined.
See DocumentStatus.
billingRequestDate (DateTime) The date of the billing request,.
loadingPoint (string) The physical location where the goods are loaded.
loadingPointAddress (string) The physical location address where the goods are loaded.
loadingStreetName (string) The street name of the physical location where the goods are loaded.
loadingBuildingNumber (string) The building number of the physical location where the goods are loaded.
loadingPostalZone (string) The postal zone of the physical location where the goods are loaded.
loadingCityName (string) The city of the physical location where the goods are loaded.
loadingCountry (string) The country of the physical location where the goods are loaded.
(fk) Allowed value: the natural key of a record of type Country. These records are accessibly through the Countries service.
unloadingPoint (string) The physical location where the goods are unloaded. Defines the unloading from the freight.
unloadingPointAddress (string) The physical location address where the goods are unloaded.
unloadingStreetName (string) The street name of the physical location where the goods are unloaded.
unloadingBuildingNumber (string) The building number of the physical location where the goods are unloaded.
unloadingPostalZone (string) The postal zone of the physical location where the goods are unloaded.
unloadingCityName (string) The city name of the physical location where the goods are unloaded.
unloadingCountry (string) The country of the physical location where the goods are unloaded.
(fk) Allowed value: the natural key of a record of type Country. These records are accessibly through the Countries service.
sourceDoc (string) The source document.
sourceDocId (Guid) The source document id.
sourceDocDate (DateTimeOffset) The source document date. Internally determined.
delivery (string) The delivery.
deliveryId (Guid) The delivery id.
altAddress (string) The alternative address.
(fk) Allowed value: the natural key of a record of type Address. These records are accessibly through the Addresses service.
accountingAltAddress (string) The accounting alternative address.
(fk) Allowed value: the natural key of a record of type Address. These records are accessibly through the Addresses service.
deliveryMode (string) The Delivery mode. (ex: mail).
(fk) Allowed value: the natural key of a record of type DeliveryMode. These records are accessibly through the DeliveryModes service.
salesperson (string) The sales person.
(fk) Allowed value: the natural key of a record of type Party. These records are accessibly through the Parties service.
dimensionSet (string) Dimension Set.
(fk) Allowed value: the natural key of a record of type DimensionSet. These records are accessibly through the DimensionSets service.
serie (string) Defines the sequence to generate the series number. Part of the document natural key. The default serie is defined on the invoice type.
(fk) Allowed value: the natural key of a record of type Serie. These records are accessibly through the Series service.
noteToRecipient (string) The note to the invoice recipient.
remarks (string) The document’s remarks.
documentDate (DateTime) The document's date.
customAttributes (string) The order custom attributes.


MoneyResource

The following elements are required:

amount (decimal) The amount.

The following elements are optional:

baseAmount (decimal) The base amount.
reportingAmount (decimal) The reporting amount.
fractionDigits (int) The fraction digits.
symbol (string) The symbol.

Notes: For the POST operation it is not necessary to send the fields: BaseAmount, ReportingAmount, FractionDigits and Symbol. Will be ignored.



Enumerations


DocumentLineStatus

1 Open
2 Completed


DocumentStatus

1 Open
2 Completed
3 Processing


ItemType

1 Item
2 Service


OrderNature

1 StandardOrder
2 ReturnOrder