Jasmin Developers - Web API Reference

Sales | Company Invoice

Overview


URL api/{tenantKey}/{orgKey}/billing/companyInvoices
Methods Supported GET

All Operations

This service includes the following operations:

All Resources

This service uses the following resources:

GET Operations

GET Get Sales Memos For Company

Custom operation 'GetSalesMemosForCompany'.

The following elements are required:

companyTaxId (string) The company’s tax identifier.
fromDate (DateTime?) The inicial date.
toDate (DateTime?) The final date.
page (int) The page’s number.
pageSize (int) The page’s size.

Response:

When successful, the response body contains a list of resources of type 'SalesCompanyInvoice'. See SalesCompanyInvoice.

Response status codes:

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

Resource URL:

GET /billing/companyInvoices/getSalesMemosForCompany/{companyTaxId}

GET Get Sales Invoices For Company

Custom operation 'GetSalesInvoicesForCompany'.

The following elements are required:

companyTaxId (string) The company’s tax identifier.
fromDate (DateTime?) The inicial date.
toDate (DateTime?) The final date.
page (int) The page’s number.
pageSize (int) The page’s size.

Response:

When successful, the response body contains a list of resources of type 'SalesCompanyInvoice'. See SalesCompanyInvoice.

Response status codes:

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

Resource URL:

GET /billing/companyInvoices/getSalesInvoicesForCompany/{companyTaxId}

Resources


SalesCompanyInvoice

The following elements are required:

allowanceChargeAmount (decimal) The total's discount over goods and services.
taxTotal (decimal) The total's tax value of goods and services.
payableAmount (decimal) The payable amount.

The following elements are optional:

accountingPartyCode (string) The accounting's party code. It is inferred from the accounting party.
accountingPartyName (string) The accounting’s party name. It is inferred from the accounting party.
accountingPartyAddress (string) The accounting’s party address. It is inferred from the accounting party.
accountingPartyPostalZone (string) The accounting’s party postal zone. It is inferred from the accounting party.
accountingPartyCity (string) The accounting’s party city. It is inferred from the accounting party.
accountingPartyCountry (string) The accounting’s party country. It is inferred from the accounting party.
accountingPartyRegion (string) The accounting’s party region. It is inferred from the accounting party.
accountingPartyPhone (string) The accounting’s party telephone. It is inferred from the accounting party.
accountingPartyEmail (string) The accounting’s party electronic mail. It is inferred from the accounting party.
accountingPartyTaxId (string) The accounting’s party tax identifier. It is inferred from the accounting party.
documentType (string) The document’s type.
series (string) The range of identification values that group a set of product entities or objects.
serieNumber (int) The sequential number internally determined that uniquely identifies the document. Part of the document natural key.
fiscalDocumentType (string) The fiscal’s document type.
state (string) The document’s state.
documentDate (string) The document’s date.