Sales APIs
Save details for provided sales credit note
| HTTP method | PUT |
| URI | https://api.rambase.net/sales/credit-notes/{salesCreditNoteId} |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {salesCreditNoteId} |
Sales credit note identifier
Integer, minimum 100000 |
| Custom fields | Custom fields supported |
| Successful HTTP status code | 200 |
| API resource identifier | 4821, version 5 |
The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.
SalesCreditNote
This field is optional.
>CustomersReference
Customers reference. Typically a person.
This field is optional.
>{String}</CustomersReference>CustomersReferenceNumber
Customers reference number. E.g. the internal sales order id the customer use in their own system.
This field is optional.
>{String}</CustomersReferenceNumber>Currency
Three character code following the ISO 4217 standard
Applicable domain values can be found here
Input must match the following regular expression pattern: ^[A-Z]{3}$
This field is optional.
>{String}</Currency>IssueDate
Date when the document was issued.
This field is optional.
>{Date}</IssueDate>CreditReason
Field used to specify the reason for the credit
This field is optional.
>{String}</CreditReason>Note
Additional information regarding the object (free text). This note might be visible to customers/suppliers.
This field is optional.
>{String}</Note>ShippingAddressAttention
Attention of the shipping address. When changing shipping address, the ShippingAddressAttention will be overridden by the attention of the new shipping address.
This field is optional.
>{String}</ShippingAddressAttention>ShippingAddressPhone
Phone number of the shipping address. When changing shipping address, the ShippingAddressPhone will be overridden by the phone number of the new shipping address.
Input must match the following regular expression pattern: ^([0-9\(\)\s\.\+\-])*$
This field is optional.
>{String}</ShippingAddressPhone>ShippingAddressEmail
Email address of the shipping address. When changing shipping address, the ShippingAddressEmail will be overridden by the email of the new shipping address.
Input must match the following regular expression pattern: ^\w+([-+.']\w+)*@\w+([-.]\w+)*\.\w+([-.]\w+)*$
This field is optional.
>{String}</ShippingAddressEmail>InvoiceAddressAttention
Attention of the invoice address. When changing invoice address, the InvoiceAddressAttention will be overridden by the attention of the new invoice address.
This field is optional.
>{String}</InvoiceAddressAttention>SellersReferenceNumber
Sellers reference number.
This field is optional.
>{String}</SellersReferenceNumber>ExternalReference
External sales credit note reference/identifier. Can be used in external systems.
This field is optional.
>{String}</ExternalReference>PolishRequirements
This field is optional.
>EUSaleToNonCompany
Sales from Poland to EU country, to natural persons who do not conduct business activity (non company).
This field is optional.
>{Boolean}</EUSaleToNonCompany>ThirdPartyTransactionCode
Transaction code used when purchasing goods in the EU by the third largest VAT payer in a triangular transaction.
Applicable domain values can be found here
This field is optional.
>{String}</ThirdPartyTransactionCode>Location
This field is optional.
>LocationId
Location identifier
Minimum value: 10000
This field is optional.
>{Integer}</LocationId>AccountingPeriod
This field is optional.
>AccountingPeriodId
Accounting period identifier
Minimum value: 199000
Maximum value: 299912
This field is optional.
>{Integer}</AccountingPeriodId>Assignee
The user who has been assigned to work with this object.
This field is optional.
>UserId
User identifier
Minimum value: 100
This field is optional.
>{Integer}</UserId>ShippingAddress
This field is optional.
>AddressId
Address identifier
Minimum value: 1
This field is optional.
>{Integer}</AddressId>Customer
This field is optional.
>CustomerId
Customer identifier
Minimum value: 10000
This field is optional.
>{Integer}</CustomerId>Totals
This field is optional.
>FeeAmount
Fee amount in transaction document's currency
Minimum value: 0
This field is optional.
>{Decimal}</FeeAmount>FreightAmount
Freight amount in transaction document's currency
Minimum value: 0
This field is optional.
>{Decimal}</FreightAmount>RoundOffAmount
Round-off amount in transaction document's currency
This field is optional.
>{Decimal}</RoundOffAmount>Shipment
This field is optional.
>DeliveryTerms
Delivery terms when shipping the goods. The delivery terms is based on the Incoterms rules from ICC (International Chamber of Commerce). The delivery terms is by default retrieved from the customer.
Applicable domain values can be found here
This field is optional.
>{String}</DeliveryTerms>DeliveryTermPlace
Named place related to delivery terms (Incoterms)
This field is optional.
>{String}</DeliveryTermPlace>Payment
This field is optional.
>PaymentMethod
Default payment method for the customer
Applicable domain values can be found here
This field is optional.
>{String}</PaymentMethod>PaymentTerms
Default payment terms to use in new documents.
Applicable domain values can be found here
This field is optional.
>{String}</PaymentTerms>DueDate
Date the object is due to be paid
This field is optional.
>{Date}</DueDate>VATDetails
This field is optional.
>PostponeVAT
Indicates that the VAT posting should be postponed
This field is optional.
>{Boolean}</PostponeVAT>VATHandling
Specifies how value added tax (VAT) should be calculated. Either always include VAT, always exclude VAT or use standard/default VAT rules.
Applicable domain values can be found here
This field is optional.
>{String}</VATHandling>VATRate
Rate between transaction currency and company VAT currency. VAT rate should be used to calculate VAT amount in company VAT currency.
This field is optional.
>{Decimal}</VATRate>VATDate
Date of VAT posting. Currency rate calculation use this date.
This field is optional.
>{Date}</VATDate>VATPeriod
Accounting period this VAT posting belongs to
Minimum value: 199000
Maximum value: 299912
This field is optional.
>{Integer}</VATPeriod>SalesCreditNote
This field is optional.
": {CustomersReference
Customers reference. Typically a person.
This field is optional.
": "{String}",CustomersReferenceNumber
Customers reference number. E.g. the internal sales order id the customer use in their own system.
This field is optional.
": "{String}",Currency
Three character code following the ISO 4217 standard
Applicable domain values can be found here
Input must match the following regular expression pattern: ^[A-Z]{3}$
This field is optional.
": "{String}",IssueDate
Date when the document was issued.
This field is optional.
": "{Date}",CreditReason
Field used to specify the reason for the credit
This field is optional.
": "{String}",Note
Additional information regarding the object (free text). This note might be visible to customers/suppliers.
This field is optional.
": "{String}",ShippingAddressAttention
Attention of the shipping address. When changing shipping address, the ShippingAddressAttention will be overridden by the attention of the new shipping address.
This field is optional.
": "{String}",ShippingAddressPhone
Phone number of the shipping address. When changing shipping address, the ShippingAddressPhone will be overridden by the phone number of the new shipping address.
Input must match the following regular expression pattern: ^([0-9\(\)\s\.\+\-])*$
This field is optional.
": "{String}",ShippingAddressEmail
Email address of the shipping address. When changing shipping address, the ShippingAddressEmail will be overridden by the email of the new shipping address.
Input must match the following regular expression pattern: ^\w+([-+.']\w+)*@\w+([-.]\w+)*\.\w+([-.]\w+)*$
This field is optional.
": "{String}",InvoiceAddressAttention
Attention of the invoice address. When changing invoice address, the InvoiceAddressAttention will be overridden by the attention of the new invoice address.
This field is optional.
": "{String}",SellersReferenceNumber
Sellers reference number.
This field is optional.
": "{String}",ExternalReference
External sales credit note reference/identifier. Can be used in external systems.
This field is optional.
": "{String}",PolishRequirements
This field is optional.
": {EUSaleToNonCompany
Sales from Poland to EU country, to natural persons who do not conduct business activity (non company).
This field is optional.
": "{Boolean}",ThirdPartyTransactionCode
Transaction code used when purchasing goods in the EU by the third largest VAT payer in a triangular transaction.
Applicable domain values can be found here
This field is optional.
": "{String}"Location
This field is optional.
": {LocationId
Location identifier
Minimum value: 10000
This field is optional.
": "{Integer}"AccountingPeriod
This field is optional.
": {AccountingPeriodId
Accounting period identifier
Minimum value: 199000
Maximum value: 299912
This field is optional.
": "{Integer}"Assignee
The user who has been assigned to work with this object.
This field is optional.
": {UserId
User identifier
Minimum value: 100
This field is optional.
": "{Integer}"ShippingAddress
This field is optional.
": {AddressId
Address identifier
Minimum value: 1
This field is optional.
": "{Integer}"Customer
This field is optional.
": {CustomerId
Customer identifier
Minimum value: 10000
This field is optional.
": "{Integer}"Totals
This field is optional.
": {FeeAmount
Fee amount in transaction document's currency
Minimum value: 0
This field is optional.
": "{Decimal}",FreightAmount
Freight amount in transaction document's currency
Minimum value: 0
This field is optional.
": "{Decimal}",RoundOffAmount
Round-off amount in transaction document's currency
This field is optional.
": "{Decimal}"Shipment
This field is optional.
": {DeliveryTerms
Delivery terms when shipping the goods. The delivery terms is based on the Incoterms rules from ICC (International Chamber of Commerce). The delivery terms is by default retrieved from the customer.
Applicable domain values can be found here
This field is optional.
": "{String}",DeliveryTermPlace
Named place related to delivery terms (Incoterms)
This field is optional.
": "{String}"Payment
This field is optional.
": {PaymentMethod
Default payment method for the customer
Applicable domain values can be found here
This field is optional.
": "{String}",PaymentTerms
Default payment terms to use in new documents.
Applicable domain values can be found here
This field is optional.
": "{String}",DueDate
Date the object is due to be paid
This field is optional.
": "{Date}"VATDetails
This field is optional.
": {PostponeVAT
Indicates that the VAT posting should be postponed
This field is optional.
": "{Boolean}",VATHandling
Specifies how value added tax (VAT) should be calculated. Either always include VAT, always exclude VAT or use standard/default VAT rules.
Applicable domain values can be found here
This field is optional.
": "{String}",VATRate
Rate between transaction currency and company VAT currency. VAT rate should be used to calculate VAT amount in company VAT currency.
This field is optional.
": "{Decimal}",VATDate
Date of VAT posting. Currency rate calculation use this date.
This field is optional.
": "{Date}",VATPeriod
Accounting period this VAT posting belongs to
Minimum value: 199000
Maximum value: 299912
This field is optional.
": "{Integer}"The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.
| $access_token String, optional | After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time. |
| $db String, optional | Set the database/company for the request |
| $useMinimumVersion Integer, optional | Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information. |
| $showCustomFields Boolean, optional | Set to "true" to include custom fields. Default value is false. |
Read more about filters and sorting on how to use filter parameters and named filters.
Read more about filters and sorting on how to use sortable parameters
Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields. Fields colored in grey is expandable fields.
Please note that some fields may be removed from the response, based on user roles/duties/permissions.
List of available operations/actions for this resource.
See the operations documentation for more information about API operations.
Possible error codes the response might return:
| Error 100191 HTTP 404 | Vatcode not found |
| Error 100475 HTTP 400 | Project number is mandatory on all items. |
| Error 101488 HTTP 400 | Illegal general ledger account : {0} |
| Error 105186 HTTP 400 | Postings are not allowed on control accounts. |
| Error 101490 HTTP 400 | Illegal Account {0}: This account has been blocked for {1}-documents |
| Error 101491 HTTP 400 | Illegal Account {0}: Check the account's FromPeriod and ToPeriod |
| Error 101517 HTTP 400 | Illegal Account {0}: This account require ICTDB. |
| Error 102482 HTTP 400 | Department is required for general ledger account {0} |
| Error 102483 HTTP 400 | Finance project is required for general ledger account {0} |
| Error 102484 HTTP 400 | Asset is required for general ledger account {0} |
| Error 102485 HTTP 400 | Dimension {0} ({1}) is required for general ledger account {2} |
| Error 101313 HTTP 400 | Department number is not valid: {0} |
| Error 101320 HTTP 400 | The project number is not valid: {0} |
| Error 101500 HTTP 400 | Project {0} could not be used : Check project FromPeriod and ToPeriod. |
| Error 101501 HTTP 400 | Asset is not allowed on general ledger account {0} |
| Error 101326 HTTP 400 | The asset number is not valid : {0} |
| Error 102486 HTTP 400 | Invalid value for dimension {0} |
| Error 108679 HTTP 400 | Expected collection date cannot be earlier then expected delivery date |
| Error 108680 HTTP 400 | Collection date cannot be earlier then the effective date |
| Error 108681 HTTP 400 | Collection date cannot be earlier then the expected delivery date |
| Error 108683 HTTP 400 | Termination date must be earlier then the expiration date |
| Error 107278 HTTP 400 | No available rental unit found for specified product and date range |